@elementor/wp-lite-env 0.0.16 → 0.0.18

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # wp-lite-env
 
+## 0.0.18
+
+### Patch Changes
+
+- 7735ac3: use fs/promises
+- 3ae029a: use Object.assign to set default configuration values
+- 82d3000: use js-yaml to generate docker-compose.yml
+- b733e44: use command-line-args
+- cb25ce7: force dir creation
+- efe3327: refactor waitForServer
+
+## 0.0.17
+
+### Patch Changes
+
+- 34f7b7c: code review fixes
+- a021f2d: code review fixes
+
 ## 0.0.16
 
 ### Patch Changes

package/__tests__/__snapshots__/template.test.ts.snap

@@ -3,15 +3,15 @@
 exports[`templates compose file generation snapshot test 1`] = `
 "services:
   mysql:
-    image: 'mariadb:lts'
+    image: mariadb:lts
     ports:
-      - '\${WP_ENV_MYSQL_PORT:-}:3306'
+      - \${WP_ENV_MYSQL_PORT:-}:3306
     environment:
       MYSQL_ROOT_HOST: '%'
       MYSQL_ROOT_PASSWORD: password
       MYSQL_DATABASE: wordpress
     volumes:
-      - 'mysql:/var/lib/mysql'
+      - mysql:/var/lib/mysql
   wordpress:
     depends_on:
       - mysql
@@ -20,11 +20,11 @@ exports[`templates compose file generation snapshot test 1`] = `
       dockerfile: WordPress.Dockerfile
       no_cache: true
       args: &ref_0
-        HOST_USERNAME: yotams
+        HOST_USERNAME: someuser
         HOST_UID: '502'
         HOST_GID: '20'
     ports:
-      - '\${WP_ENV_PORT:-1234}:80'
+      - \${WP_ENV_PORT:-1234}:80
     environment:
       APACHE_RUN_USER: '#502'
       APACHE_RUN_GROUP: '#20'
@@ -32,13 +32,10 @@ exports[`templates compose file generation snapshot test 1`] = `
       WORDPRESS_DB_PASSWORD: password
       WORDPRESS_DB_NAME: wordpress
     volumes: &ref_1
-      - >-
-        wpcontent:/var/www/html
-      - >-
-        /some/wp-config/path:/var/www/html/wp-config
-
+      - wpcontent:/var/www/html
+      - /some/wp-config/path:/var/www/html/wp-config
     extra_hosts:
-      - 'host.docker.internal:host-gateway'
+      - host.docker.internal:host-gateway
   cli:
     depends_on:
       - wordpress
@@ -53,7 +50,7 @@ exports[`templates compose file generation snapshot test 1`] = `
       WORDPRESS_DB_PASSWORD: password
       WORDPRESS_DB_NAME: wordpress
     extra_hosts:
-      - 'host.docker.internal:host-gateway'
+      - host.docker.internal:host-gateway
 volumes:
   mysql: {}
   wpcontent: {}

package/__tests__/config.test.ts

@@ -8,13 +8,13 @@ describe('config', () => {
     test('defaults', () => {
         (fs.readFileSync as unknown as MockInstance).mockReturnValueOnce(JSON.stringify({"some" : "data"}));
         const config = getConfig('some/path');
-        expect(config).toEqual({
+        expect(config).toEqual(expect.objectContaining({
             core: '6.7',
             phpVersion: '8.1',
             plugins: {},
             themes: {},
             mappings: {},
             config: {},
-        });
+        }));
     });
 });

package/__tests__/e2e.ts

@@ -1,11 +1,11 @@
 import {afterEach, beforeAll, describe, expect, test} from "@jest/globals";
 import {generateFiles, getConfigFilePath, start, stop} from "../src/run";
 
-const port = '1234';
+const port = 1234;
 
 describe('end to end tests', () => {
     beforeAll(async () => {
-        generateFiles(port, getConfigFilePath(['', '', '', 'config=./tests/.wp-lite-env.json']));
+        await generateFiles(port, getConfigFilePath(['', '', '', 'config=./__tests__/.wp-lite-env.json']));
     })
     afterEach(async () => {
         await stop(port);

package/__tests__/template.test.ts

@@ -30,7 +30,7 @@ describe('templates', () => {
                     "WP_DEBUG": false
                 }
             };
-            const configTemplate = generateConfiguration( config, '1234' );
+            const configTemplate = generateConfiguration( config, 1234 );
             expect(configTemplate).toMatchSnapshot();
         });
     });
@@ -42,7 +42,7 @@ describe('templates', () => {
                 plugins: {},
                 themes: {},
             }
-            const composeYml = generateDockerComposeYmlTemplate( config, '/some/base/path', '1234', '/some/wp-config/path' );
+            const composeYml = generateDockerComposeYmlTemplate( config, '/some/base/path', 1234, '/some/wp-config/path' );
             expect(composeYml).toMatchSnapshot();
         });
         test('mappings are mounted correctly', () => {
@@ -55,7 +55,7 @@ describe('templates', () => {
                 themes: {},
             }
             const basePath = '/some/base/path';
-            const composeYml = generateDockerComposeYmlTemplate( config, basePath, '1234', '/some/wp-config/path' );
+            const composeYml = generateDockerComposeYmlTemplate( config, basePath, 1234, '/some/wp-config/path' );
             expect(composeYml).toMatch(new RegExp(`${basePath}/some/container/path:/var/www/html/some/host/path`));
             expect(composeYml).toMatch(new RegExp(`${basePath}/some/other/container/path:/var/www/html/some/other/host/path`));
         });
@@ -70,7 +70,7 @@ describe('templates', () => {
                 themes: {},
             }
             const basePath = '/some/base/path';
-            const composeYml = generateDockerComposeYmlTemplate( config, basePath, '1234', '/some/wp-config/path' );
+            const composeYml = generateDockerComposeYmlTemplate( config, basePath, 1234, '/some/wp-config/path' );
             expect(composeYml).toMatch(new RegExp(`/some/base/some/plugin/path:/var/www/html/wp-content/plugins/plugin1`));
             expect(composeYml).toMatch(new RegExp(`/some/base/some/other/plugin/path:/var/www/html/wp-content/plugins/plugin2`));
         });
@@ -84,7 +84,7 @@ describe('templates', () => {
                 },
             }
             const basePath = '/some/base/path';
-            const composeYml = generateDockerComposeYmlTemplate( config, basePath, '1234', '/some/wp-config/path' );
+            const composeYml = generateDockerComposeYmlTemplate( config, basePath, 1234, '/some/wp-config/path' );
             expect(composeYml).toMatch(new RegExp(`/some/base/some/theme/path:/var/www/html/wp-content/themes/theme1`));
             expect(composeYml).toMatch(new RegExp(`/some/base/some/other/theme/path:/var/www/html/wp-content/themes/theme2`));
         });
@@ -96,7 +96,7 @@ describe('templates', () => {
                 themes: {},
             }
             const basePath = '/some/base/path';
-            const composeYml = generateDockerComposeYmlTemplate( config, basePath, '1234', '/some/wp-config/path' );
+            const composeYml = generateDockerComposeYmlTemplate( config, basePath, 1234, '/some/wp-config/path' );
             expect(composeYml).toMatch(new RegExp(`/some/wp-config/path:/var/www/html/wp-config`));
         });
     });

package/dist/bin.cjs

@@ -22,6 +22,9 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 
+// src/bin.ts
+var import_command_line_args = __toESM(require("command-line-args"), 1);
+
 // src/run.ts
 var import_docker_compose = require("docker-compose");
 var import_path2 = __toESM(require("path"), 1);
@@ -41,100 +44,108 @@ var getConfig = (configFilePath2) => {
     mappings: {},
     config: {}
   };
-  return {
-    core: configFile.core || defaultConfig.core,
-    phpVersion: configFile.phpVersion || defaultConfig.phpVersion,
-    plugins: configFile.plugins || defaultConfig.plugins,
-    themes: configFile.themes || defaultConfig.themes,
-    mappings: configFile.mappings || defaultConfig.mappings,
-    config: configFile.config || defaultConfig.config
-  };
+  return Object.assign({}, defaultConfig, configFile);
 };
 
 // src/run.ts
-var import_fs2 = __toESM(require("fs"), 1);
+var import_promises = __toESM(require("fs/promises"), 1);
 
 // src/templates.ts
 var import_path = __toESM(require("path"), 1);
-var generateDockerComposeYmlTemplate = (config, basePath, port2, configPath) => {
+var import_js_yaml = require("js-yaml");
+var generateVolumeMapping = (basePath, configPath, config) => {
   const mappingsStringArray = Object.keys(config.mappings).map((key) => {
     const value = config.mappings[key];
-    return `      - >-
-        ${import_path.default.resolve(basePath, value)}:/var/www/html/${key}
-`;
+    return `${import_path.default.resolve(basePath, value)}:/var/www/html/${key}`;
   });
   const pluginsStringArray = Object.keys(config.plugins).map((key) => {
     const value = config.plugins[key];
-    return `      - >-
-        ${import_path.default.resolve(basePath, value)}:/var/www/html/wp-content/plugins/${key}
-`;
+    return `${import_path.default.resolve(basePath, value)}:/var/www/html/wp-content/plugins/${key}`;
   });
   const themesStringArray = Object.keys(config.themes).map((key) => {
     const value = config.themes[key];
-    return `      - >-
-        ${import_path.default.resolve(basePath, value)}:/var/www/html/wp-content/themes/${key}
-`;
+    return `${import_path.default.resolve(basePath, value)}:/var/www/html/wp-content/themes/${key}`;
   });
-  const wpContent = `      - >-
-        wpcontent:/var/www/html
-`;
-  const wpConfig = `      - >-
-        ${configPath}:/var/www/html/wp-config
-`;
-  const volumes = mappingsStringArray.concat(pluginsStringArray).concat(themesStringArray).concat([wpContent, wpConfig]).join("");
-  return `services:
-  mysql:
-    image: 'mariadb:lts'
-    ports:
-      - '\${WP_ENV_MYSQL_PORT:-}:3306'
-    environment:
-      MYSQL_ROOT_HOST: '%'
-      MYSQL_ROOT_PASSWORD: password
-      MYSQL_DATABASE: wordpress
-    volumes:
-      - 'mysql:/var/lib/mysql'
-  wordpress:
-    depends_on:
-      - mysql
-    build:
-      context: .
-      dockerfile: WordPress.Dockerfile
-      no_cache: true
-      args: &ref_0
-        HOST_USERNAME: yotams
-        HOST_UID: '502'
-        HOST_GID: '20'
-    ports:
-      - '\${WP_ENV_PORT:-${port2}}:80'
-    environment:
-      APACHE_RUN_USER: '#502'
-      APACHE_RUN_GROUP: '#20'
-      WORDPRESS_DB_USER: root
-      WORDPRESS_DB_PASSWORD: password
-      WORDPRESS_DB_NAME: wordpress
-    volumes: &ref_1
-${volumes}
-    extra_hosts:
-      - 'host.docker.internal:host-gateway'
-  cli:
-    depends_on:
-      - wordpress
-    build:
-      context: .
-      dockerfile: CLI.Dockerfile
-      args: *ref_0
-    volumes: *ref_1
-    user: '502:20'
-    environment:
-      WORDPRESS_DB_USER: root
-      WORDPRESS_DB_PASSWORD: password
-      WORDPRESS_DB_NAME: wordpress
-    extra_hosts:
-      - 'host.docker.internal:host-gateway'
-volumes:
-  mysql: {}
-  wpcontent: {}
-`;
+  const wpContent = `wpcontent:/var/www/html`;
+  const wpConfig = `${configPath}:/var/www/html/wp-config`;
+  return mappingsStringArray.concat(pluginsStringArray).concat(themesStringArray).concat([wpContent, wpConfig]);
+};
+var generateDockerComposeYmlTemplate = (config, basePath, port2, configPath) => {
+  const hostUid = "502";
+  const hostGid = "20";
+  const wordpressDbUser = "root";
+  const wordpressDbPassword = "password";
+  const wordpressDbName = "wordpress";
+  const args = {
+    HOST_USERNAME: "someuser",
+    HOST_UID: hostUid,
+    HOST_GID: hostGid
+  };
+  const volumes = generateVolumeMapping(basePath, configPath, config);
+  const compose = {
+    services: {
+      mysql: {
+        image: "mariadb:lts",
+        ports: [
+          "${WP_ENV_MYSQL_PORT:-}:3306"
+        ],
+        environment: {
+          MYSQL_ROOT_HOST: "%",
+          MYSQL_ROOT_PASSWORD: "password",
+          MYSQL_DATABASE: "wordpress"
+        },
+        volumes: [
+          "mysql:/var/lib/mysql"
+        ]
+      },
+      wordpress: {
+        depends_on: ["mysql"],
+        build: {
+          context: ".",
+          dockerfile: "WordPress.Dockerfile",
+          no_cache: true,
+          args
+        },
+        ports: [
+          `\${WP_ENV_PORT:-${port2}}:80`
+        ],
+        environment: {
+          APACHE_RUN_USER: `#${hostUid}`,
+          APACHE_RUN_GROUP: `#${hostGid}`,
+          WORDPRESS_DB_USER: wordpressDbUser,
+          WORDPRESS_DB_PASSWORD: wordpressDbPassword,
+          WORDPRESS_DB_NAME: wordpressDbName
+        },
+        volumes,
+        extra_hosts: [
+          "host.docker.internal:host-gateway"
+        ]
+      },
+      cli: {
+        depends_on: ["wordpress"],
+        build: {
+          context: ".",
+          dockerfile: "CLI.Dockerfile",
+          args
+        },
+        volumes,
+        user: `${hostUid}:${hostGid}`,
+        environment: {
+          WORDPRESS_DB_USER: wordpressDbUser,
+          WORDPRESS_DB_PASSWORD: wordpressDbPassword,
+          WORDPRESS_DB_NAME: wordpressDbName
+        },
+        extra_hosts: [
+          "host.docker.internal:host-gateway"
+        ]
+      }
+    },
+    volumes: {
+      mysql: {},
+      wpcontent: {}
+    }
+  };
+  return (0, import_js_yaml.dump)(compose);
 };
 var generateWordPressDockerfileTemplate = (config) => {
   return `FROM wordpress:${config.core}-php${config.phpVersion}
@@ -176,22 +187,28 @@ set -eox pipefail
 var import_crypto = require("crypto");
 var import_node_os = __toESM(require("os"), 1);
 var waitForServer = async (url, timeoutMs) => {
-  const startTime = Date.now();
   const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
-  while (startTime + timeoutMs > Date.now()) {
+  const pollEveryMs = 100;
+  let retries = timeoutMs / pollEveryMs;
+  while (retries > 0) {
     try {
       const response = await fetch(url);
-      if (response.ok && (200 === response.status || 302 === response.status)) {
+      if (200 === response.status || 302 === response.status) {
         return true;
       }
     } catch (e) {
-    } finally {
-      await sleep(100);
+      if ("ECONNREFUSED" !== e.cause?.code) {
+        console.warn(`Encountered an error while waiting for server to start: ${e.message}
+Trying to reach server again.`);
+      }
     }
+    await sleep(pollEveryMs);
+    retries--;
   }
+  console.error(`Server did not start within ${timeoutMs}ms`);
   return false;
 };
-var getRunPath = (port2) => import_path2.default.resolve(import_node_os.default.tmpdir(), port2);
+var getRunPath = (port2) => import_path2.default.resolve(import_node_os.default.tmpdir(), `${port2}`);
 var start = async (port2) => {
   const runPath = getRunPath(port2);
   await (0, import_docker_compose.upAll)({
@@ -200,7 +217,7 @@ var start = async (port2) => {
     cwd: runPath,
     log: true
   });
-  await waitForServer(`http://localhost:${port2}`, 1e4);
+  await waitForServer(`http://0.0.0.0:${port2}`, 1e4);
   await cli(port2, "bash wp-config/configure-wp.sh");
 };
 var stop = async (port2) => {
@@ -211,7 +228,7 @@ var stop = async (port2) => {
     composeOptions: ["-p", `port${port2}`],
     log: true
   });
-  cleanup(port2);
+  await cleanup(port2);
 };
 var cli = async (port2, command2) => {
   const runPath = getRunPath(port2);
@@ -227,62 +244,43 @@ var commandMap = {
   stop,
   cli
 };
-var getWpConfigPath = (port2) => import_path2.default.resolve(process.cwd(), port2);
-var generateFiles = (port2, configFilePath2) => {
+var getWpConfigPath = (port2) => import_path2.default.resolve(process.cwd(), `${port2}`);
+var generateFiles = async (port2, configFilePath2) => {
   const config = getConfig(configFilePath2);
   const wpConfigPath = getWpConfigPath(port2);
-  if (!import_fs2.default.existsSync(wpConfigPath)) {
-    import_fs2.default.mkdirSync(wpConfigPath, { recursive: true });
-  }
+  await import_promises.default.mkdir(wpConfigPath, { recursive: true });
   const wpConfig = generateConfiguration(config, port2);
-  import_fs2.default.writeFileSync(import_path2.default.resolve(wpConfigPath, "configure-wp.sh"), wpConfig);
+  await import_promises.default.writeFile(import_path2.default.resolve(wpConfigPath, "configure-wp.sh"), wpConfig);
   const dockerComposeYmlTemplate = generateDockerComposeYmlTemplate(config, process.cwd(), port2, wpConfigPath);
   const wordPressDockerfileTemplate = generateWordPressDockerfileTemplate(config);
   const cliDockerfileTemplate = generateCliDockerfileTemplate(config);
   const hash = (0, import_crypto.createHash)("sha256");
   hash.update(dockerComposeYmlTemplate + wordPressDockerfileTemplate + cliDockerfileTemplate + port2);
   const runPath = getRunPath(port2);
-  if (!import_fs2.default.existsSync(runPath)) {
-    import_fs2.default.mkdirSync(runPath);
-  }
+  await import_promises.default.mkdir(runPath, { recursive: true });
   console.log(`writing files to run path: ${runPath}`);
-  import_fs2.default.writeFileSync(import_path2.default.resolve(runPath, "docker-compose.yml"), dockerComposeYmlTemplate);
-  import_fs2.default.writeFileSync(import_path2.default.resolve(runPath, "WordPress.Dockerfile"), wordPressDockerfileTemplate);
-  import_fs2.default.writeFileSync(import_path2.default.resolve(runPath, "CLI.Dockerfile"), cliDockerfileTemplate);
+  await import_promises.default.writeFile(import_path2.default.resolve(runPath, "docker-compose.yml"), dockerComposeYmlTemplate);
+  await import_promises.default.writeFile(import_path2.default.resolve(runPath, "WordPress.Dockerfile"), wordPressDockerfileTemplate);
+  await import_promises.default.writeFile(import_path2.default.resolve(runPath, "CLI.Dockerfile"), cliDockerfileTemplate);
   return runPath;
 };
-var getArgument = (argumentKey, processArgs) => {
-  for (let i = 3; i < processArgs.length; i++) {
-    const argument = processArgs[i];
-    if (argument.startsWith(`${argumentKey}=`)) {
-      return argument.substring(argumentKey.length + 1);
-    }
-  }
-  return void 0;
-};
-var getConfigFilePath = (processArgs) => {
-  return import_path2.default.resolve(getArgument("config", processArgs));
-};
-var getCliCommand = (processArgs) => {
-  return getArgument("command", processArgs);
-};
-var getPort = (processArgs) => {
-  return getArgument("port", processArgs) || "8888";
-};
-var cleanup = (port2) => {
+var cleanup = async (port2) => {
   const runPath = getRunPath(port2);
-  import_fs2.default.rmSync(getWpConfigPath(port2), { recursive: true, force: true });
-  import_fs2.default.rmSync(runPath, { recursive: true, force: true });
+  await import_promises.default.rm(getWpConfigPath(port2), { recursive: true, force: true });
+  await import_promises.default.rm(runPath, { recursive: true, force: true });
 };
 
 // src/bin.ts
-var command = process.argv[2];
-if (!commandMap[command]) {
-  console.log(`Valid commands: ${Object.keys(commandMap).join(", ")}. You used ${command}`);
-}
-var port = getPort(process.argv);
-var configFilePath = getConfigFilePath(process.argv);
-var cliCommand = getCliCommand(process.argv);
-generateFiles(port, configFilePath);
-commandMap[command](port, cliCommand);
+var cliOptionDefinitions = [
+  { name: "cmd", type: String, defaultOption: true, description: 'The command to run. Can be one of "start", "stop" or "cli"' },
+  { name: "config", type: String, description: "Path to the configuration file defining the WordPress environment." },
+  { name: "port", type: Number, description: "Port to run the WordPress environment on" },
+  { name: "command", type: String, defaultValue: "", description: "The command to run by the WP CLI" }
+];
+var cliOptions = (0, import_command_line_args.default)(cliOptionDefinitions);
+var command = cliOptions.cmd;
+var port = cliOptions.port;
+var configFilePath = cliOptions.config;
+var cliCommand = cliOptions.command;
+generateFiles(port, configFilePath).then(() => commandMap[command](port, cliCommand));
 //# sourceMappingURL=bin.cjs.map

package/dist/bin.js

@@ -1,20 +1,21 @@
 #!/usr/bin/env node
 import {
   commandMap,
-  generateFiles,
-  getCliCommand,
-  getConfigFilePath,
-  getPort
-} from "./chunk-UBXF6D42.js";
+  generateFiles
+} from "./chunk-FNPCY3S6.js";
 
 // src/bin.ts
-var command = process.argv[2];
-if (!commandMap[command]) {
-  console.log(`Valid commands: ${Object.keys(commandMap).join(", ")}. You used ${command}`);
-}
-var port = getPort(process.argv);
-var configFilePath = getConfigFilePath(process.argv);
-var cliCommand = getCliCommand(process.argv);
-generateFiles(port, configFilePath);
-commandMap[command](port, cliCommand);
+import commandLineArgs from "command-line-args";
+var cliOptionDefinitions = [
+  { name: "cmd", type: String, defaultOption: true, description: 'The command to run. Can be one of "start", "stop" or "cli"' },
+  { name: "config", type: String, description: "Path to the configuration file defining the WordPress environment." },
+  { name: "port", type: Number, description: "Port to run the WordPress environment on" },
+  { name: "command", type: String, defaultValue: "", description: "The command to run by the WP CLI" }
+];
+var cliOptions = commandLineArgs(cliOptionDefinitions);
+var command = cliOptions.cmd;
+var port = cliOptions.port;
+var configFilePath = cliOptions.config;
+var cliCommand = cliOptions.command;
+generateFiles(port, configFilePath).then(() => commandMap[command](port, cliCommand));
 //# sourceMappingURL=bin.js.map