Support specifing `config.yaml` in cli

26a520af1075f053982b8dab718e5a4b4ef09d1c

wrvsrx <wrvsrx@outlook.com>

Signed

Parents: bf97686dfc99a1b01d10b043b794dd5626083f23

server.js+41 -38 Viewed

 // local library imports
 import './src/fetch-patch.js';
 -import { serverEvents, EVENT_NAMES } from './src/server-events.js';
 import { CommandLineParser } from './src/command-line.js';
 import { loadPluginsserverDirectory } from './src/pluginserver-loaderdirectory.js';
 -import {
++
 +console.log(`Node version: ${process.version}. Running in ${process.env.NODE_ENV} environment. Server directory: ${serverDirectory}`);
++
 +// Work around a node v20.0.0, v20.1.0, and v20.2.0 bug. The issue was fixed in v20.3.0.
 +// https://github.com/nodejs/node/issues/47822#issuecomment-1564708870
 +// Safe to remove once support for Node v20 is dropped.
 +if (process.versions && process.versions.node && process.versions.node.match(/20\.[0-2]\.0/)) {
 +    // @ts-ignore
 +    if (net.setDefaultAutoSelectFamily) net.setDefaultAutoSelectFamily(false);
 +}
++
 +// config.yaml will be set when parsing command line arguments
 +const cliArgs = new CommandLineParser().parse(process.argv);
 +globalThis.DATA_ROOT = cliArgs.dataRoot;
 +globalThis.COMMAND_LINE_ARGS = cliArgs;
 +process.chdir(serverDirectory);
++
 +const { serverEvents, EVENT_NAMES } = await import('./src/server-events.js');
 +const { loadPlugins } = await import('./src/plugin-loader.js');
 +const {
     initUserStorage,
     getCookieSecret,
     getCookieSessionName,

     getSessionCookieAge,
     verifySecuritySettings,
     loginPageMiddleware,
 } from= await import('./src/users.js');
 importconst { default: getWebpackServeMiddleware from} = await import('./src/middleware/webpack-serve.js');
 importconst { default: basicAuthMiddleware from} = await import('./src/middleware/basicAuth.js');
 importconst { default: getWhitelistMiddleware from} = await import('./src/middleware/whitelist.js');
 importconst { default: accessLoggerMiddleware, { getAccessLogPath, migrateAccessLog } from= await import('./src/middleware/accessLogWriter.js');
 importconst { default: multerMonkeyPatch from} = await import('./src/middleware/multerMonkeyPatch.js');
 importconst { default: initRequestProxy from} = await import('./src/request-proxy.js');
 importconst { default: getCacheBusterMiddleware from} = await import('./src/middleware/cacheBuster.js');
 importconst { default: corsProxyMiddleware from} = await import('./src/middleware/corsProxy.js');
 importconst {
     getVersion,
     color,
     removeColorFormatting,

     safeReadFileSync,
     setupLogLevel,
     setWindowTitle,
 } from= await import('./src/util.js');
 importconst { UPLOADS_DIRECTORY } from= await import('./src/constants.js');
 importconst { ensureThumbnailCache } from= await import('./src/endpoints/thumbnails.js');
 -import { serverDirectory } from './src/server-directory.js';
 // Routers
 importconst { router as: usersPublicRouter } from= await import('./src/endpoints/users-public.js');
 importconst { init as: statsInit, onExit as: statsOnExit } from= await import('./src/endpoints/stats.js');
 importconst { checkForNewContent } from= await import('./src/endpoints/content-manager.js');
 importconst { init as: settingsInit } from= await import('./src/endpoints/settings.js');
 importconst { redirectDeprecatedEndpoints, ServerStartup, setupPrivateEndpoints } from= await import('./src/server-startup.js');
 importconst { diskCache } from= await import('./src/endpoints/characters.js');
 // Unrestrict console logs display limit
 util.inspect.defaultOptions.maxArrayLength = null;
 util.inspect.defaultOptions.maxStringLength = null;
 util.inspect.defaultOptions.depth = 4;
 -console.log(`Node version: ${process.version}. Running in ${process.env.NODE_ENV} environment. Server directory: ${serverDirectory}`);
+-
 -// Work around a node v20.0.0, v20.1.0, and v20.2.0 bug. The issue was fixed in v20.3.0.
 -// https://github.com/nodejs/node/issues/47822#issuecomment-1564708870
 -// Safe to remove once support for Node v20 is dropped.
 -if (process.versions && process.versions.node && process.versions.node.match(/20\.[0-2]\.0/)) {
 -    // @ts-ignore
 -    if (net.setDefaultAutoSelectFamily) net.setDefaultAutoSelectFamily(false);
 -}
+-
 -const cliArgs = new CommandLineParser().parse(process.argv);
 -globalThis.DATA_ROOT = cliArgs.dataRoot;
 -globalThis.COMMAND_LINE_ARGS = cliArgs;
+-
 if (!cliArgs.enableIPv6 && !cliArgs.enableIPv4) {
     console.error('error: You can\'t disable all internet protocols: at least IPv6 or IPv4 must be enabled.');
     process.exit(1);

src/command-line.js+11 -1 Viewed

 import yargs from 'yargs/yargs';
 import { hideBin } from 'yargs/helpers';
 import ipRegex from 'ip-regex';
 import { canResolve, color, getConfigValue, setConfigFilePath, stringToBool } from './util.js';
 /**
  * @typedef {object} CommandLineArguments Parsed command line arguments
 + * @property {string} configPath Path to the config file
  * @property {string} dataRoot Data root directory
  * @property {number} port Port number
  * @property {boolean} listen If SillyTavern is listening on all network interfaces

     constructor() {
         /** @type {CommandLineArguments} */
         this.default = Object.freeze({
 +            configPath: './config.yaml',
             dataRoot: './data',
             port: 8000,
             listen: false,

     parse(args) {
         const cliArguments = yargs(hideBin(args))
             .usage('Usage: <your-start-script> [options]\nOptions that are not provided will be filled with config values.')
 +            .option('configPath', {
 +                type: 'string',
 +                default: null,
 +                describe: 'Path to the config file',
 +            })
             .option('enableIPv6', {
                 type: 'string',
                 default: null,

                 describe: 'Request proxy bypass list (space separated list of hosts)',
             }).parseSync();
 +        const configPath = cliArguments.configPath ?? this.default.configPath;
 +        setConfigFilePath(configPath);
         /** @type {CommandLineArguments} */
         const result = {
 +            configPath: configPath,
             dataRoot: cliArguments.dataRoot ?? getConfigValue('dataRoot', this.default.dataRoot),
             port: cliArguments.port ?? getConfigValue('port', this.default.port, 'number'),
             listen: cliArguments.listen ?? getConfigValue('listen', this.default.listen, 'boolean'),

src/util.js+19 -3 Viewed

  * Parsed config object.
  */
 let CACHED_CONFIG = null;
 +let CONFIG_FILE = null;
 /**
  * Converts a configuration key to an environment variable key.

 export const keyToEnv = (key) => 'SILLYTAVERN_' + String(key).toUpperCase().replace(/\./g, '_');
 /**
 + * Set the config file path.
 + * @param {string} configFilePath Path to the config file
 + */
 +export function setConfigFilePath(configFilePath) {
 +    if (CONFIG_FILE !== null) {
 +        console.error(color.red('Config file path already set. Please restart the server to change the config file path.'));
 +    }
 +    CONFIG_FILE = path.resolve(configFilePath);
 +}
++
 +/**
  * Returns the config object from the config.yaml file.
  * @returns {object} Config object
  */
 export function getConfig() {
 +    if (CONFIG_FILE === null) {
 +        console.trace();
 +        console.error(color.red('No config file path set. Please set the config file path using setConfigFilePath().'));
 +        process.exit(1);
 +    }
     if (CACHED_CONFIG) {
         return CACHED_CONFIG;
+    }
+-
 +    if (!fs.existsSync(CONFIG_FILE)) {
 -    if (!fs.existsSync('./config.yaml')) {
         console.error(color.red('No config file found. Please create a config.yaml file. The default config file can be found in the /default folder.'));
         console.error(color.red('The program will now exit.'));
         process.exit(1);
+    }
     try {
         const config = yaml.parse(fs.readFileSync(path.join(process.cwd(), './config.yaml')CONFIG_FILE, 'utf8'));
         CACHED_CONFIG = config;
         return config;
     } catch (error) {