orionplace-react 0.7.8 → 0.8.0

package/src/install.mjs

@@ -1,356 +0,0 @@
-// Installs the built storefront as a system service on a Linux server and
-// connects its domains through the "orionplace" server tool
-// (https://orionmarket.place/downloads/orionplace.sh) when that tool is set up.
-import { spawn } from 'node:child_process';
-import { mkdir, readFile, readdir, rename, stat, writeFile } from 'node:fs/promises';
-import { existsSync } from 'node:fs';
-import { request } from 'node:http';
-import { createServer } from 'node:net';
-import { basename, dirname, join, resolve } from 'node:path';
-import { createInterface } from 'node:readline/promises';
-import { setupProject } from './setup.mjs';
-
-export const framework = {
-  id:          'react',
-  title:       'Next.js',
-  dependency:  'next',
-  output:      '.next/BUILD_ID',
-  start:       port => ['node_modules/next/dist/bin/next', 'start', '--hostname', '127.0.0.1', '--port', String(port)],
-  environment: {},
-};
-
-export const defaultPaths = {
-  etc:     process.env.ORIONPLACE_ETC || '/etc/orionplace',
-  systemd: '/etc/systemd/system',
-  openrc:  '/etc/init.d',
-  logs:    '/var/log/orionplace',
-  srv:     '/srv/orionplace',
-  tool:    ['/usr/local/bin/orionplace', '/usr/bin/orionplace'],
-};
-
-const SERVICE_USER = 'orionplace';
-
-// run(command, args, { cwd, capture, env }) -> { code, output }
-export function runCommand(command, args, { cwd, capture = false, env = process.env } = {}) {
-  return new Promise((done, reject) => {
-    const child  = spawn(command, args, { cwd, env, stdio: capture ? ['ignore', 'pipe', 'pipe'] : 'inherit' });
-    let output   = '';
-    if (capture) {
-      child.stdout.on('data', chunk => { output += chunk; });
-      child.stderr.on('data', chunk => { output += chunk; });
-    }
-    child.once('error', reject);
-    child.once('exit', code => done({ code: code ?? 1, output }));
-  });
-}
-
-function parseConf(text) {
-  const values = {};
-  for (const line of text.split('\n')) {
-    const match = /^([A-Z_]+)=(.*)$/.exec(line);
-    if (match) values[match[1]] = match[2];
-  }
-  return values;
-}
-
-export async function readApps(paths = defaultPaths) {
-  const directory = join(paths.etc, 'apps');
-  let names       = [];
-  try { names = (await readdir(directory)).filter(name => name.endsWith('.conf')); }
-  catch (error) { if (error.code !== 'ENOENT') throw error; }
-  const apps      = [];
-  for (const name of names) apps.push(parseConf(await readFile(join(directory, name), 'utf8')));
-  return apps;
-}
-
-export function serviceName(value) {
-  const name = value.toLowerCase().replace(/[^a-z0-9-]+/g, '-').replace(/^-+|-+$/g, '').slice(0, 40);
-  if (!/^[a-z0-9][a-z0-9-]*$/.test(name)) throw new Error('Choose a service name with letters, digits and dashes: --name shop');
-  return name;
-}
-
-function portIsFree(port) {
-  return new Promise(done => {
-    const server = createServer();
-    server.once('error', () => done(false));
-    server.listen({ port, host: '127.0.0.1', exclusive: true }, () => server.close(() => done(true)));
-  });
-}
-
-export async function choosePort(apps, wanted, isFree = portIsFree) {
-  const taken = new Set(apps.map(app => Number(app.PORT)));
-  if (wanted) {
-    if (!Number.isInteger(wanted) || wanted < 1024 || wanted > 65535) throw new Error('Use a port between 1024 and 65535.');
-    return wanted;
-  }
-  for (let port = 3000; port < 4000; port++) {
-    if (!taken.has(port) && await isFree(port)) return port;
-  }
-  throw new Error('No free port between 3000 and 3999. Choose one with --port.');
-}
-
-async function passwdEntry(user) {
-  const text = await readFile('/etc/passwd', 'utf8');
-  for (const line of text.split('\n')) {
-    const [name, , uid, gid, , home] = line.split(':');
-    if (name === user) return { name, uid: Number(uid), gid: Number(gid), home };
-  }
-  return null;
-}
-
-async function userByUid(uid) {
-  const text = await readFile('/etc/passwd', 'utf8');
-  for (const line of text.split('\n')) {
-    const [name, , id, gid, , home] = line.split(':');
-    if (Number(id) === uid && name) return { name, uid, gid: Number(gid), home };
-  }
-  return null;
-}
-
-// Every parent folder must let the service user through.
-async function checkReachable(root, account) {
-  let cursor = dirname(root);
-  while (true) {
-    const info = await stat(cursor);
-    const open = info.uid === account.uid ? info.mode & 0o100 : info.gid === account.gid ? info.mode & 0o010 : info.mode & 0o001;
-    if (!open) {
-      throw new Error(`The folder ${cursor} is closed to the service user ${account.name}. Move the storefront to ${defaultPaths.srv}/ (for example ${defaultPaths.srv}/${basename(root)}) and run install there.`);
-    }
-    if (cursor === dirname(cursor)) return;
-    cursor = dirname(cursor);
-  }
-}
-
-async function writeAtomic(path, content, mode = 0o644) {
-  await mkdir(dirname(path), { recursive: true });
-  const temporary = `${path}.orionplace-${process.pid}.tmp`;
-  await writeFile(temporary, content, { mode });
-  await rename(temporary, path);
-}
-
-export function systemdUnit({ name, root, user, group, port, node, env }) {
-  const environment = Object.entries({ NODE_ENV: 'production', HOST: '127.0.0.1', PORT: String(port), SITEMAPS_DIR: join(root, 'sitemaps'), ...env })
-    .map(([key, value]) => `Environment=${key}=${value}`).join('\n');
-  const args        = [...(existsSync(join(root, '.env')) ? ['--env-file=.env'] : []), ...framework.start(port)];
-  return `# Installed by "orionplace-${framework.id} install". Run it again after changes;
-# manage with: orionplace app status|logs|restart ${name}
-[Unit]
-Description=OrionMarketplace storefront ${name} (${framework.title})
-After=network-online.target
-Wants=network-online.target
-
-[Service]
-Type=simple
-User=${user}
-Group=${group}
-WorkingDirectory=${root}
-${environment}
-ExecStart=${node} ${args.join(' ')}
-Restart=on-failure
-RestartSec=3
-LimitNOFILE=65535
-NoNewPrivileges=true
-PrivateTmp=true
-ProtectSystem=full
-
-[Install]
-WantedBy=multi-user.target
-`;
-}
-
-export function openrcScript({ name, root, user, group, port, node, env, logs }) {
-  const environment = Object.entries({ NODE_ENV: 'production', HOST: '127.0.0.1', PORT: String(port), SITEMAPS_DIR: join(root, 'sitemaps'), ...env })
-    .map(([key, value]) => `export ${key}="${value}"`).join('\n');
-  const args        = [...(existsSync(join(root, '.env')) ? ['--env-file=.env'] : []), ...framework.start(port)];
-  return `#!/sbin/openrc-run
-# Installed by "orionplace-${framework.id} install". Run it again after changes;
-# manage with: orionplace app status|logs|restart ${name}
-name="orionplace-${name}"
-description="OrionMarketplace storefront ${name} (${framework.title})"
-supervisor=supervise-daemon
-respawn_delay=3
-command="${node}"
-command_args="${args.join(' ')}"
-command_user="${user}:${group}"
-directory="${root}"
-output_log="${logs}/${name}.log"
-error_log="${logs}/${name}.log"
-${environment}
-
-depend() {
-  need net
-  after firewall
-}
-
-start_pre() {
-  checkpath --directory --owner ${user}:${group} --mode 0755 ${logs}
-}
-`;
-}
-
-async function prompt(question) {
-  const terminal = createInterface({ input: process.stdin, output: process.stdout });
-  try { return (await terminal.question(question)).trim(); }
-  finally { terminal.close(); }
-}
-
-function log(message) { console.log(message); }
-
-// /usr/local/bin/node from the server tool follows Node.js updates; the
-// versioned path of the running binary would not.
-function stableNode() {
-  return ['/usr/local/bin/node', '/usr/bin/node'].find(path => existsSync(path)) || process.execPath;
-}
-
-// Fills in the backend and first storefront domain when the project has none.
-async function ensureDomains(root, { yes }) {
-  const read     = async () => JSON.parse(await readFile(join(root, 'orionplace/settings.json'), 'utf8'));
-  let settings   = await read();
-  const ask      = process.stdin.isTTY && !yes;
-  if (!settings.backend) {
-    if (!ask) throw new Error(`Set the personal backend first: npx orionplace-${framework.id} set backend my-shop.orionplace.app`);
-    log('Your personal backend is shown in your orionmarket.place profile, for example my-shop.orionplace.app.');
-    await setupProject({ cwd: root, field: 'backend', value: await prompt('Personal backend domain: ') });
-    settings = await read();
-  }
-  if (!settings.frontends?.length) {
-    if (!ask) throw new Error(`Add the storefront domain first: npx orionplace-${framework.id} add frontend shop.example.com`);
-    await setupProject({ cwd: root, action: 'add', field: 'frontend', value: await prompt('Storefront domain (for example shop.example.com): ') });
-    settings = await read();
-  }
-  return settings;
-}
-
-// The storefront's home page as the public domain sees it -> HTTP status, 0 when down.
-export function homeStatus(port, host) {
-  return new Promise(done => {
-    const call = request({ host: '127.0.0.1', port, path: '/', headers: { host }, timeout: 15000 }, response => {
-      response.resume();
-      done(response.statusCode);
-    });
-    call.once('timeout', () => call.destroy());
-    call.once('error', () => done(0));
-    call.end();
-  });
-}
-
-export async function waitForHttp(port, host, seconds = 90) {
-  const until = Date.now() + seconds * 1000;
-  while (Date.now() < until) {
-    const status = await homeStatus(port, host);
-    if (status) return status;
-    await new Promise(done => setTimeout(done, 1000));
-  }
-  return 0;
-}
-
-export async function installService({
-  cwd = process.cwd(), name, port, user, build = true, domains = true, yes = false, dryRun = false,
-  paths = defaultPaths, run = runCommand, uid = process.getuid?.(), isFree = portIsFree,
-  systemd = existsSync('/run/systemd/system'), node = stableNode(),
-} = {}) {
-  if (process.platform !== 'linux') throw new Error('install sets up a Linux server service. Run it on your VPS.');
-  if (uid !== 0 && !dryRun) throw new Error(`install needs root: sudo npx orionplace-${framework.id} install`);
-  const root     = resolve(cwd);
-  if (!/^\/[A-Za-z0-9._/@+-]+$/.test(root)) throw new Error(`Use a storefront folder path without spaces or special characters (for example ${paths.srv}/shop), not ${root}.`);
-  let pkg;
-  try { pkg = JSON.parse(await readFile(join(root, 'package.json'), 'utf8')); }
-  catch { throw new Error(`Run install in your storefront folder (created with: npx orionplace-${framework.id} init).`); }
-  if (!{ ...pkg.devDependencies, ...pkg.dependencies }[framework.dependency] || !existsSync(join(root, 'orionplace/settings.json'))) {
-    throw new Error(`This folder is not an Orionplace ${framework.title} storefront. Run install in the folder created with: npx orionplace-${framework.id} init`);
-  }
-  const openrc   = !systemd && existsSync('/sbin/openrc-run');
-  if (!systemd && !openrc && !dryRun) throw new Error('Neither systemd nor OpenRC was found; start the storefront with your own process manager (see orionplace/README.md, Deploy on your VPS).');
-
-  const settings = dryRun ? JSON.parse(await readFile(join(root, 'orionplace/settings.json'), 'utf8')) : await ensureDomains(root, { yes });
-  const apps     = await readApps(paths);
-  const previous = apps.find(app => app.DIR === root);
-  const service  = serviceName(name || previous?.NAME || basename(root));
-  if (apps.some(app => app.NAME === service && app.DIR !== root)) {
-    throw new Error(`Another storefront already uses the name ${service} (${apps.find(app => app.NAME === service).DIR}). Choose one with --name.`);
-  }
-  const chosen   = await choosePort(apps.filter(app => app.DIR !== root), port ? Number(port) : Number(previous?.PORT) || 0, isFree);
-
-  // The service runs as the folder's owner, or as "orionplace" for root-owned folders.
-  const owner    = await stat(root);
-  let account    = user ? await passwdEntry(user) : owner.uid === 0 ? await passwdEntry(SERVICE_USER) : await userByUid(owner.uid);
-  if (user && !account) throw new Error(`No system user ${user}.`);
-  if (!account && !dryRun) {
-    if (existsSync('/usr/sbin/useradd') || existsSync('/sbin/useradd')) {
-      await run('useradd', ['--system', '--home-dir', paths.srv, '--shell', '/sbin/nologin', '--user-group', SERVICE_USER], { capture: true });
-    } else {
-      await run('addgroup', ['-S', SERVICE_USER], { capture: true });
-      await run('adduser', ['-S', '-D', '-H', '-h', paths.srv, '-s', '/sbin/nologin', '-G', SERVICE_USER, SERVICE_USER], { capture: true });
-    }
-    account = await passwdEntry(SERVICE_USER);
-    if (!account) throw new Error(`Could not create the system user ${SERVICE_USER}.`);
-  }
-  account      ||= { name: SERVICE_USER, uid: -1, gid: -1 };
-  const group    = account.gid >= 0 ? (await readFile('/etc/group', 'utf8')).split('\n').map(line => line.split(':'))
-    .find(([, , gid]) => Number(gid) === account.gid)?.[0] || account.name : account.name;
-  if (account.uid >= 0) await checkReachable(root, account);
-
-  const values   = { name: service, root, user: account.name, group, port: chosen, node, env: framework.environment, logs: paths.logs };
-  const unitPath = systemd ? join(paths.systemd, `orionplace-${service}.service`) : join(paths.openrc, `orionplace-${service}`);
-  const unit     = systemd ? systemdUnit(values) : openrcScript(values);
-  const conf     = [
-    `# Managed by orionplace-${framework.id} install. Use "orionplace app" commands to change it.`,
-    `NAME=${service}`, `FRAMEWORK=${framework.id}`, `DIR=${root}`, `PORT=${chosen}`,
-    `USER=${account.name}`, `NODE=${node}`, `SERVICE=orionplace-${service}`, '',
-  ].join('\n');
-  if (dryRun) {
-    return { dryRun, name: service, port: chosen, user: account.name, unitPath, unit, conf, frontends: settings.frontends || [], backend: settings.backend };
-  }
-
-  const rebuild  = build || !existsSync(join(root, framework.output));
-  log(rebuild ? `\n==> Building the ${framework.title} storefront ${service}` : `\n==> Using the existing build of ${service} (--no-build)`);
-  // The website build; ORIONPLACE_APP_ORIGIN would make the Android app build.
-  const buildEnv = { ...process.env };
-  delete buildEnv.ORIONPLACE_APP_ORIGIN;
-  if (!existsSync(join(root, 'node_modules', framework.dependency))) {
-    const installed = await run('npm', ['install', '--no-audit', '--no-fund'], { cwd: root, env: buildEnv });
-    if (installed.code) throw new Error('npm install failed; see the messages above.');
-  }
-  if (rebuild) {
-    const built = await run('npm', ['run', 'build'], { cwd: root, env: buildEnv });
-    if (built.code) throw new Error('The build failed; see the messages above. The running service (if any) was not changed.');
-  }
-  if (!existsSync(join(root, framework.output))) throw new Error(`The build did not produce ${framework.output}.`);
-  const owned    = await run('chown', ['-R', `${account.uid}:${account.gid}`, root], { capture: true });
-  if (owned.code) throw new Error(`Could not give ${root} to ${account.name}:\n${owned.output}`);
-
-  log(`\n==> Installing the service orionplace-${service} on port ${chosen}`);
-  await writeAtomic(unitPath, unit, systemd ? 0o644 : 0o755);
-  await writeAtomic(join(paths.etc, 'apps', `${service}.conf`), conf);
-  const steps    = systemd
-    ? [['systemctl', ['daemon-reload']], ['systemctl', ['enable', `orionplace-${service}`]], ['systemctl', ['restart', `orionplace-${service}`]]]
-    : [['rc-update', ['add', `orionplace-${service}`, 'default']], ['rc-service', [`orionplace-${service}`, 'restart']]];
-  for (const [command, args] of steps) {
-    const result = await run(command, args, { capture: true });
-    if (result.code) throw new Error(`${command} ${args.join(' ')} failed:\n${result.output}`);
-  }
-  const status   = await waitForHttp(chosen, settings.frontends[0]);
-  if (!status) {
-    const logs = systemd
-      ? await run('journalctl', ['-u', `orionplace-${service}`, '-n', '40', '--no-pager'], { capture: true })
-      : await run('tail', ['-n', '40', join(paths.logs, `${service}.log`)], { capture: true });
-    throw new Error(`The storefront did not start on port ${chosen}. Last log lines:\n${logs.output}`);
-  }
-  log(`  ✓ orionplace-${service} answers on 127.0.0.1:${chosen} (HTTP ${status})`);
-
-  const tool     = paths.tool.find(path => existsSync(path));
-  const failed   = [];
-  if (domains && tool) {
-    for (const domain of settings.frontends) {
-      log(`\n==> Connecting ${domain}`);
-      const backend = settings.backend.replace(/^https:\/\//, '').replace(/\/api$/, '');
-      const result  = await run(tool, ['domain', 'add', domain, '--app', service, '--backend', backend, '--yes']);
-      if (result.code) failed.push(domain);
-    }
-  } else if (domains) {
-    log('\nThe orionplace server tool is not set up, so nginx and HTTPS were not configured. Prepare the server:');
-    log('  curl -fsSLo orionplace.sh https://orionmarket.place/downloads/orionplace.sh && sudo sh orionplace.sh setup');
-    log(`Then run this install again. Or proxy your HTTPS site to http://127.0.0.1:${chosen} as orionplace/README.md describes.`);
-  }
-  return { name: service, port: chosen, user: account.name, unitPath, frontends: settings.frontends, failed, connected: domains && Boolean(tool) };
-}