@elementor/wp-lite-env 0.0.18 → 0.0.20

package/.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Release
 on:
   push:
     branches:
-      - initial
+      - main
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

package/.github/workflows/require-changesets.yml

@@ -10,7 +10,7 @@ on:
       - edited
       - synchronize
     branches:
-      - initial
+      - main
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # wp-lite-env
 
+## 0.0.20
+
+### Patch Changes
+
+- 27e57a1: use a proper logger
+
+## 0.0.19
+
+### Patch Changes
+
+- 6f6b9ac: put retries-- in finally block, or theres a condition where it runs forever
+- 6f6b9ac: add test for template generation
+- 6f6b9ac: add a bin test
+
 ## 0.0.18
 
 ### Patch Changes

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

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`templates compose file generation snapshot test 1`] = `
+exports[`templates compose file generation compose generated with correct empty values 1`] = `
 "services:
   mysql:
     image: mariadb:lts
@@ -57,6 +57,71 @@ volumes:
 "
 `;
 
+exports[`templates compose file generation compose generated with correct values 1`] = `
+"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: someuser
+        HOST_UID: '502'
+        HOST_GID: '20'
+    ports:
+      - \${WP_ENV_PORT:-1234}: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
+      - /some/base/path/some/container/path:/var/www/html/some/host/path
+      - >-
+        /some/base/path/some/other/container/path:/var/www/html/some/other/host/path
+      - /some/base/some/plugin/path:/var/www/html/wp-content/plugins/plugin1
+      - >-
+        /some/base/some/other/plugin/path:/var/www/html/wp-content/plugins/plugin2
+      - /some/base/some/theme/path:/var/www/html/wp-content/themes/theme1
+      - /some/base/some/other/theme/path:/var/www/html/wp-content/themes/theme2
+      - wpcontent:/var/www/html
+      - /some/wp-config/path:/var/www/html/wp-config
+    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: {}
+"
+`;
+
 exports[`templates configuration file generation config file is generated with the correct values 1`] = `
 "#!/bin/bash
 set -eox pipefail

package/__tests__/e2e.ts

@@ -1,19 +1,26 @@
-import {afterEach, beforeAll, describe, expect, test} from "@jest/globals";
+import {describe, expect, test} from "@jest/globals";
 import {generateFiles, getConfigFilePath, start, stop} from "../src/run";
+import {execSync} from "node:child_process";
 
 const port = 1234;
 
 describe('end to end tests', () => {
-    beforeAll(async () => {
-        await generateFiles(port, getConfigFilePath(['', '', '', 'config=./__tests__/.wp-lite-env.json']));
-    })
-    afterEach(async () => {
-        await stop(port);
-    }, 30000);
     test('WordPress is up and running', async () => {
-        await start( port );
+        await generateFiles(port, getConfigFilePath(['', '', '', 'config=./__tests__/.wp-lite-env.json']));
+        try {
+            await start(port);
+            const response = await fetch(`http://localhost:${port}`);
+            expect(response.ok).toBe(true);
+            expect(await response.text()).toContain('Welcome to WordPress');
+        } finally {
+            await stop(port);
+        }
+    }, 60000);
+    test('WordPress is up and running using binary (requires building the library!)', async () => {
+        execSync('npx wp-lite-env start --config=./__tests__/.wp-lite-env.json --port=1234');
         const response = await fetch(`http://localhost:${port}`);
         expect(response.ok).toBe(true);
         expect(await response.text()).toContain('Welcome to WordPress');
+        execSync('npx wp-lite-env stop --config=./__tests__/.wp-lite-env.json --port=1234');
     }, 60000);
 });

package/__tests__/template.test.ts

@@ -36,7 +36,7 @@ describe('templates', () => {
     });
 
     describe('compose file generation', () => {
-        test('snapshot test', () => {
+        test('compose generated with correct empty values', () => {
             const config = {
                 mappings: {},
                 plugins: {},
@@ -45,6 +45,24 @@ describe('templates', () => {
             const composeYml = generateDockerComposeYmlTemplate( config, '/some/base/path', 1234, '/some/wp-config/path' );
             expect(composeYml).toMatchSnapshot();
         });
+        test('compose generated with correct values', () => {
+            const config = {
+                mappings: {
+                    'some/host/path': 'some/container/path',
+                    'some/other/host/path': 'some/other/container/path',
+                },
+                plugins: {
+                    'plugin1': '../some/plugin/path',
+                    'plugin2': '../some/other/plugin/path',
+                },
+                themes: {
+                    'theme1': '../some/theme/path',
+                    'theme2': '../some/other/theme/path',
+                },
+            }
+            const composeYml = generateDockerComposeYmlTemplate( config, '/some/base/path', 1234, '/some/wp-config/path' );
+            expect(composeYml).toMatchSnapshot();
+        });
         test('mappings are mounted correctly', () => {
             const config = {
                 mappings: {

package/dist/bin.cjs

@@ -186,6 +186,8 @@ set -eox pipefail
 // src/run.ts
 var import_crypto = require("crypto");
 var import_node_os = __toESM(require("os"), 1);
+var import_pino = __toESM(require("pino"), 1);
+var logger = (0, import_pino.default)();
 var waitForServer = async (url, timeoutMs) => {
   const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
   const pollEveryMs = 100;
@@ -198,14 +200,15 @@ var waitForServer = async (url, timeoutMs) => {
       }
     } catch (e) {
       if ("ECONNREFUSED" !== e.cause?.code) {
-        console.warn(`Encountered an error while waiting for server to start: ${e.message}
+        logger.warn(`Encountered an error while waiting for server to start: ${e.message}
 Trying to reach server again.`);
       }
+    } finally {
+      retries--;
     }
     await sleep(pollEveryMs);
-    retries--;
   }
-  console.error(`Server did not start within ${timeoutMs}ms`);
+  logger.error(`Server did not start within ${timeoutMs}ms`);
   return false;
 };
 var getRunPath = (port2) => import_path2.default.resolve(import_node_os.default.tmpdir(), `${port2}`);
@@ -258,7 +261,7 @@ var generateFiles = async (port2, configFilePath2) => {
   hash.update(dockerComposeYmlTemplate + wordPressDockerfileTemplate + cliDockerfileTemplate + port2);
   const runPath = getRunPath(port2);
   await import_promises.default.mkdir(runPath, { recursive: true });
-  console.log(`writing files to run path: ${runPath}`);
+  logger.debug(`writing files to run path: ${runPath}`);
   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);

package/dist/bin.js

@@ -2,7 +2,7 @@
 import {
   commandMap,
   generateFiles
-} from "./chunk-FNPCY3S6.js";
+} from "./chunk-POVI6WIB.js";
 
 // src/bin.ts
 import commandLineArgs from "command-line-args";

package/dist/{chunk-FNPCY3S6.js → chunk-POVI6WIB.js}

@@ -159,6 +159,8 @@ set -eox pipefail
 // src/run.ts
 import { createHash } from "crypto";
 import os from "node:os";
+import { default as pino } from "pino";
+var logger = pino();
 var waitForServer = async (url, timeoutMs) => {
   const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
   const pollEveryMs = 100;
@@ -171,14 +173,15 @@ var waitForServer = async (url, timeoutMs) => {
       }
     } catch (e) {
       if ("ECONNREFUSED" !== e.cause?.code) {
-        console.warn(`Encountered an error while waiting for server to start: ${e.message}
+        logger.warn(`Encountered an error while waiting for server to start: ${e.message}
 Trying to reach server again.`);
       }
+    } finally {
+      retries--;
     }
     await sleep(pollEveryMs);
-    retries--;
   }
-  console.error(`Server did not start within ${timeoutMs}ms`);
+  logger.error(`Server did not start within ${timeoutMs}ms`);
   return false;
 };
 var getRunPath = (port) => path2.resolve(os.tmpdir(), `${port}`);
@@ -231,7 +234,7 @@ var generateFiles = async (port, configFilePath) => {
   hash.update(dockerComposeYmlTemplate + wordPressDockerfileTemplate + cliDockerfileTemplate + port);
   const runPath = getRunPath(port);
   await fs2.mkdir(runPath, { recursive: true });
-  console.log(`writing files to run path: ${runPath}`);
+  logger.debug(`writing files to run path: ${runPath}`);
   await fs2.writeFile(path2.resolve(runPath, "docker-compose.yml"), dockerComposeYmlTemplate);
   await fs2.writeFile(path2.resolve(runPath, "WordPress.Dockerfile"), wordPressDockerfileTemplate);
   await fs2.writeFile(path2.resolve(runPath, "CLI.Dockerfile"), cliDockerfileTemplate);
@@ -250,4 +253,4 @@ export {
   commandMap,
   generateFiles
 };
-//# sourceMappingURL=chunk-FNPCY3S6.js.map
+//# sourceMappingURL=chunk-POVI6WIB.js.map

package/dist/index.cjs

@@ -45,6 +45,8 @@ var import_js_yaml = require("js-yaml");
 
 // src/run.ts
 var import_node_os = __toESM(require("os"), 1);
+var import_pino = __toESM(require("pino"), 1);
+var logger = (0, import_pino.default)();
 var waitForServer = async (url, timeoutMs) => {
   const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
   const pollEveryMs = 100;
@@ -57,14 +59,15 @@ var waitForServer = async (url, timeoutMs) => {
       }
     } catch (e) {
       if ("ECONNREFUSED" !== e.cause?.code) {
-        console.warn(`Encountered an error while waiting for server to start: ${e.message}
+        logger.warn(`Encountered an error while waiting for server to start: ${e.message}
 Trying to reach server again.`);
       }
+    } finally {
+      retries--;
     }
     await sleep(pollEveryMs);
-    retries--;
   }
-  console.error(`Server did not start within ${timeoutMs}ms`);
+  logger.error(`Server did not start within ${timeoutMs}ms`);
   return false;
 };
 var getRunPath = (port) => import_path.default.resolve(import_node_os.default.tmpdir(), `${port}`);

package/dist/index.js

@@ -2,7 +2,7 @@ import {
   cli,
   start,
   stop
-} from "./chunk-FNPCY3S6.js";
+} from "./chunk-POVI6WIB.js";
 export {
   cli,
   start,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elementor/wp-lite-env",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "private": false,
   "description": "A simple, lightweight, docker-based WordPress environment",
   "main": "dist/index.cjs",
@@ -33,7 +33,8 @@
   "dependencies": {
     "command-line-args": "^6.0.1",
     "docker-compose": "^1.1.0",
-    "js-yaml": "^4.1.0"
+    "js-yaml": "^4.1.0",
+    "pino": "^9.5.0"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.9",

package/src/run.ts

@@ -10,7 +10,9 @@ import {
 } from "./templates";
 import {createHash} from "crypto";
 import os from "node:os";
+import { default as pino } from "pino";
 
+const logger = pino();
 const waitForServer = async ( url: string, timeoutMs: number ) => {
     const sleep = ( ms: number ) => new Promise( ( r ) => setTimeout( r, ms ) );
 
@@ -25,13 +27,14 @@ const waitForServer = async ( url: string, timeoutMs: number ) => {
             }
         } catch ( e ) {
             if ( 'ECONNREFUSED' !== e.cause?.code ) {
-                console.warn( `Encountered an error while waiting for server to start: ${ e.message }\nTrying to reach server again.` );
+                logger.warn( `Encountered an error while waiting for server to start: ${ e.message }\nTrying to reach server again.` );
             }
+        } finally {
+            retries--;
         }
         await sleep (pollEveryMs);
-        retries--;
     }
-    console.error( `Server did not start within ${ timeoutMs }ms` );
+    logger.error( `Server did not start within ${ timeoutMs }ms` );
     return false;
 };
 
@@ -96,7 +99,7 @@ export const generateFiles = async ( port: number, configFilePath: string ) => {
     const runPath = getRunPath( port );
     await fs.mkdir( runPath, { recursive: true } );
 
-    console.log( `writing files to run path: ${ runPath }` );
+    logger.debug( `writing files to run path: ${ runPath }` );
     await fs.writeFile( path.resolve( runPath, 'docker-compose.yml' ), dockerComposeYmlTemplate );
     await fs.writeFile( path.resolve( runPath, 'WordPress.Dockerfile' ), wordPressDockerfileTemplate );
     await fs.writeFile( path.resolve( runPath, 'CLI.Dockerfile' ), cliDockerfileTemplate );