Updates

Author: nkwwk

package-lock.json

@@ -21,6 +21,7 @@
   "license": "ISC",
   "dependencies": {
     "@aws-sdk/client-s3": "^3.386.0",
+    "app-root-path": "^3.1.0",
     "archiver": "^5.3.1",
     "axios": "^1.7.9",
     "commander": "^11.0.0",
@@ -50,6 +51,7 @@
     "ts-node": "^10.9.1",
     "tsc-alias": "^1.8.7",
     "typescript": "^5.7.3",
-    "vitest": "^2.1.8"
+    "vitest": "^2.1.8",
+    "vitest-mock-extended": "^2.0.2"
   }
 }

package.json

@@ -2,13 +2,14 @@
 import { Command } from 'commander';
 import fs from 'fs';
 import path from 'path';
-import shell from 'shelljs';
 
-import backupBootstrap from '@/bootstrap/backup.js';
-import repairBootstrap from '@/bootstrap/repair.js';
-import setupBootstrap from '@/bootstrap/setup.js';
-import templateBootstrap from '@/bootstrap/template.js';
+import BackupBootstrap from '@/bootstrap/backup.js';
+import RepairBootstrap from '@/bootstrap/repair.js';
+import SetupBootstrap from '@/bootstrap/setup.js';
+import TemplateBootstrap from '@/bootstrap/template.js';
 import DatabaseService from '@/service/database';
+import { isDirectory, isFile } from '@/util/path';
+import { isMySQLInstalled, isPHPInstalled } from '@/util/unix';
 
 const program = new Command();
 
@@ -18,7 +19,7 @@ program
   .version('1.0.0', '-v, --version');
 
 program.command('template').action(async function () {
-  await templateBootstrap.handler();
+  await TemplateBootstrap.handler();
 });
 
 program
@@ -33,10 +34,10 @@ program
   .requiredOption('-d, --directory <directory>', 'root directory for website', '.')
   .action(async (options) => {
     const { template: templateFilePath, directory, host, port, username, password, dev } = options;
-    if (!fs.existsSync(templateFilePath)) {
-      throw new Error(`File not exists in ${templateFilePath}.`);
+    if (!isFile(templateFilePath)) {
+      throw new Error('Please provide the correct file path.');
     }
-    if (!shell.which('php')) {
+    if (!isPHPInstalled()) {
       throw new Error('The host need to install php to make it works.');
     }
     if (!dev) {
@@ -45,7 +46,7 @@ program
       }
       if (
         (host === undefined || host === 'localhost' || host === '127.0.0.1') &&
-        !shell.which('mysqld')
+        !isMySQLInstalled()
       ) {
         throw new Error('Using localhost or 127.0.0.1 must be installed MySQL database on host.');
       }
@@ -55,7 +56,7 @@ program
       return;
     }
     const template = JSON.parse(fs.readFileSync(templateFilePath, 'utf8'));
-    await setupBootstrap.handler(
+    await SetupBootstrap.handler(
       path.isAbsolute(directory) ? directory : path.join(process.cwd(), directory),
       template,
       dev,
@@ -74,23 +75,23 @@ program
   .requiredOption('-d, --directory <directory>', 'root directory for website', '.')
   .action(async (options) => {
     const { domain, directory, host, port, username, password } = options;
-    if (!shell.which('php')) {
+    if (!isPHPInstalled()) {
       throw new Error('The host need to install php to make it works.');
     }
     if (process.getuid && process.getuid() !== 0) {
       throw new Error('The process needs root permission when production mode.');
     }
     if (
       (host === undefined || host === 'localhost' || host === '127.0.0.1') &&
-      !shell.which('mysqld')
+      !isMySQLInstalled()
     ) {
       throw new Error('Using localhost or 127.0.0.1 must be installed MySQL database on host.');
     }
     const accessible = await new DatabaseService({ host, port, username, password }).isAccessible();
     if (accessible) {
       return;
     }
-    await repairBootstrap.handler(directory, domain, { host, port, username, password });
+    await RepairBootstrap.handler(directory, domain, { host, port, username, password });
   });
 
 program
@@ -103,13 +104,13 @@ program
   .requiredOption('-k, --secret-access-key <secretAccessKey>', 'AWS s3 bucket secret access key')
   .action(async (options) => {
     const { username, password, directory, accessKeyId, secretAccessKey } = options;
-    if (!fs.existsSync(directory) || !fs.lstatSync(directory).isDirectory()) {
+    if (!isDirectory(directory)) {
       throw new Error('Root directory not exists.');
     }
     if (directory === '/') {
       throw new Error('Cannot archive the root directory.');
     }
-    await backupBootstrap.handler(directory, username, password, accessKeyId, secretAccessKey);
+    await BackupBootstrap.handler(directory, username, password, accessKeyId, secretAccessKey);
   });
 
 program.parseAsync();

src/bin/app.ts

@@ -1,40 +1,14 @@
 import { PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
-import archiver from 'archiver';
-import { spawn } from 'child_process';
 import { format } from 'date-fns';
 import fs from 'fs';
 import tmp from 'tmp';
 
 import { getWpConfigByPath } from '@/util/config';
+import { backup } from '@/util/database';
+import { zipFiles } from '@/util/zip';
 
-async function backupDatabase(
-  host: string,
-  port: number,
-  user: string,
-  pass: string,
-  database: string,
-  fileStream: fs.WriteStream
-) {
-  const mysqldump = spawn('mysqldump', [
-    '-h',
-    host,
-    '-P',
-    port.toString(),
-    '-u',
-    user,
-    '-p' + pass,
-    database,
-  ]);
-  return new Promise(function (resolve, reject) {
-    mysqldump.stdout.on('error', reject).pipe(fileStream);
-
-    fileStream.on('finish', resolve);
-    fileStream.on('error', reject);
-  });
-}
-
-export default {
-  handler: async function (
+export default class BackupBootstrap {
+  static async handler(
     rootDir: string,
     dbUser: string,
     dbPass: string,
@@ -50,40 +24,14 @@ export default {
     if (database === undefined) {
       throw new Error("wp-config.php don't contains DB_NAME parameter.");
     }
-    await backupDatabase(
-      dbHost,
-      dbPort,
-      dbUser,
-      dbPass,
-      database,
-      fs.createWriteStream(sqlFile.name)
-    );
+    await backup(fs.createWriteStream(sqlFile.name), dbHost, dbPort, dbUser, dbPass, database);
+
     const archiveFile = tmp.fileSync({
       mode: 0o600,
       prefix: 'wp-backup-',
       postfix: '.zip',
     });
-    const outputStream = fs.createWriteStream(archiveFile.name);
-    const archive = archiver('zip', {
-      zlib: { level: 9 },
-    });
-    outputStream.on('close', function () {
-      console.log(archive.pointer() + ' total bytes');
-      console.log('archiver has been finalized and the output file descriptor has closed.');
-    });
-    outputStream.on('end', function () {
-      console.log('Data has been drained');
-    });
-    archive.on('error', function (err) {
-      throw err;
-    });
-    archive.pipe(outputStream);
-
-    // archive entire website into archive
-    archive.directory(rootDir, 'website');
-    archive.file(archiveFile.name, { name: 'dump.sql' });
-
-    await archive.finalize();
+    await zipFiles(fs.createWriteStream(archiveFile.name), rootDir, archiveFile.name);
 
     const client = new S3Client({
       credentials: {
@@ -103,5 +51,5 @@ export default {
     await client.send(command);
 
     console.log('Finished to backup the website.');
-  },
-};
+  }
+}

src/bootstrap/backup.ts

@@ -3,8 +3,8 @@ import shell from 'shelljs';
 import InstallationService from '@/service/installation';
 import { MySQLCredential } from '@/type/common';
 
-export default {
-  handler: async function (directory: string, domain: string, database: MySQLCredential) {
+export default class RepairBootstrap {
+  static async handler(directory: string, domain: string, database: MySQLCredential) {
     const { phpVer } = await InstallationService.setup(
       directory,
       domain,
@@ -19,5 +19,5 @@ export default {
     if (shell.exec(`systemctl restart php${phpVer}-fpm`).code !== 0) {
       throw new Error('Failed to restart php service');
     }
-  },
-};
+  }
+}

src/bootstrap/repair.ts

@@ -8,8 +8,8 @@ import InstallationService from '@/service/installation';
 import { MySQLCredential, WPTemplate } from '@/type/common';
 import { unzip } from '@/util/zip';
 
-export default {
-  handler: async function (
+export default class SetupBootstrap {
+  static async handler(
     directory: string,
     template: WPTemplate,
     isDev: boolean,
@@ -65,5 +65,5 @@ export default {
     if (shell.exec(`systemctl restart php${phpVer}-fpm`).code !== 0) {
       throw new Error('Failed to restart php service');
     }
-  },
-};
+  }
+}

src/bootstrap/setup.ts

@@ -1,22 +1,35 @@
 import inquirer from 'inquirer';
 import psl from 'psl';
 
-export default {
-  handler: async function() {
-    const { domain } = await inquirer.prompt({ name: 'domain', message: 'domain for the website?' });
+export default class TemplateBootstrap {
+  static async handler() {
+    const { domain } = await inquirer.prompt({
+      name: 'domain',
+      message: 'domain for the website?',
+    });
     if (!psl.isValid(domain)) {
       throw new Error('domain is not vaild TLD inside public suffix list');
     }
-    const { version } = await inquirer.prompt({ name: 'version', message: 'version of wordpress?', default: 'latest' });
-    console.log(JSON.stringify({
-      domain,
-      version,
-      themes: {
-        twentytwentythree: 'latest',
-      },
-      plugins: {
-        akismet: 'latest',
-      },
-    }, undefined, 4));
+    const { version } = await inquirer.prompt({
+      name: 'version',
+      message: 'version of wordpress?',
+      default: 'latest',
+    });
+    console.log(
+      JSON.stringify(
+        {
+          domain,
+          version,
+          themes: {
+            twentytwentythree: 'latest',
+          },
+          plugins: {
+            akismet: 'latest',
+          },
+        },
+        undefined,
+        4
+      )
+    );
   }
-}
+}