@fishawack/lab-env 5.0.0-beta.1 → 5.0.0

package/.env.example

@@ -0,0 +1,2 @@
+# HUB_URL="http://localhost:8000"
+# HUB_TOKEN=

package/CHANGELOG.md

@@ -1,5 +1,49 @@
 ## Changelog
 
+### 5.0.0 (2025-10-29)
+
+#### Features
+
+* added branch config sync from the hub on content command ([105e04c](https://bitbucket.org/fishawackdigital/lab-env/commits/105e04c29525afc1fd67e1affbda09bf269deaca))
+* added hub.js ([6966d89](https://bitbucket.org/fishawackdigital/lab-env/commits/6966d89b42345276e088e627fe2d6769efaf044d))
+* added package command ([51e42b8](https://bitbucket.org/fishawackdigital/lab-env/commits/51e42b83f166400bb404d0013b2c65bdce1e071c))
+* copy .env.example in lab-env root if present ([c85d60b](https://bitbucket.org/fishawackdigital/lab-env/commits/c85d60b5c389f3fcad185290a3e6058572e59e8d))
+* **core@1:** point to 1.8.0-beta.2 ([aaaed0a](https://bitbucket.org/fishawackdigital/lab-env/commits/aaaed0af45bde22341fbeb2e59467902be747aff))
+* export core config to globals ([0907327](https://bitbucket.org/fishawackdigital/lab-env/commits/0907327ca0b04af9032e90814d4bb7aef796ad87))
+* expose remote in globals ([7f440cb](https://bitbucket.org/fishawackdigital/lab-env/commits/7f440cb51bd7db884f89c069901f7431d8b09b11))
+* **laravel:** source env.sh when present by default ([7fe564a](https://bitbucket.org/fishawackdigital/lab-env/commits/7fe564a85b014c67cfcc6d34e699c8e7e5d77acd))
+* setup hub logging on deployments ([65c3ea6](https://bitbucket.org/fishawackdigital/lab-env/commits/65c3ea632a06b4d7cafc7b118bd68774268f63df))
+
+#### Bug Fixes
+
+* dont ignore bootstrap files now a lot of laravel code is in there ([92d67c2](https://bitbucket.org/fishawackdigital/lab-env/commits/92d67c2dc9e065a2781a2ff02ee559fb615fc90f))
+* switched from elasticsearch to opensearch ([a589384](https://bitbucket.org/fishawackdigital/lab-env/commits/a5893848e37415d769419f4dc54549b0cd6408c6))
+
+#### Build Updates
+
+* added example env ([7c5e3ba](https://bitbucket.org/fishawackdigital/lab-env/commits/7c5e3baf05023ae3ca1a8d5632d297052b3a1443))
+* **core/1:** Bumped lab-env-core-1 ([a0ce4c7](https://bitbucket.org/fishawackdigital/lab-env/commits/a0ce4c77514c2bb3b24870e63d5ec23b411db9b6))
+* ignore env varS ([c94c127](https://bitbucket.org/fishawackdigital/lab-env/commits/c94c1274de85c4818cbbc7a7683678dc6edf5d17))
+* installed dotenv and form-data ([ebb4969](https://bitbucket.org/fishawackdigital/lab-env/commits/ebb49697308b359c8be7343950dad20577531c16))
+
+### 5.0.0-beta.2 (2025-10-29)
+
+#### Features
+
+* added branch config sync from the hub on content command ([105e04c](https://bitbucket.org/fishawackdigital/lab-env/commits/105e04c29525afc1fd67e1affbda09bf269deaca))
+* added hub.js ([6966d89](https://bitbucket.org/fishawackdigital/lab-env/commits/6966d89b42345276e088e627fe2d6769efaf044d))
+* added package command ([51e42b8](https://bitbucket.org/fishawackdigital/lab-env/commits/51e42b83f166400bb404d0013b2c65bdce1e071c))
+* copy .env.example in lab-env root if present ([c85d60b](https://bitbucket.org/fishawackdigital/lab-env/commits/c85d60b5c389f3fcad185290a3e6058572e59e8d))
+* export core config to globals ([0907327](https://bitbucket.org/fishawackdigital/lab-env/commits/0907327ca0b04af9032e90814d4bb7aef796ad87))
+* expose remote in globals ([7f440cb](https://bitbucket.org/fishawackdigital/lab-env/commits/7f440cb51bd7db884f89c069901f7431d8b09b11))
+* setup hub logging on deployments ([65c3ea6](https://bitbucket.org/fishawackdigital/lab-env/commits/65c3ea632a06b4d7cafc7b118bd68774268f63df))
+
+#### Build Updates
+
+* added example env ([7c5e3ba](https://bitbucket.org/fishawackdigital/lab-env/commits/7c5e3baf05023ae3ca1a8d5632d297052b3a1443))
+* ignore env varS ([c94c127](https://bitbucket.org/fishawackdigital/lab-env/commits/c94c1274de85c4818cbbc7a7683678dc6edf5d17))
+* installed dotenv and form-data ([ebb4969](https://bitbucket.org/fishawackdigital/lab-env/commits/ebb49697308b359c8be7343950dad20577531c16))
+
 ### 5.0.0-beta.1 (2025-10-27)
 
 #### Features

package/_Test/hub.js

@@ -0,0 +1,91 @@
+"use strict";
+
+const path = require("path");
+const expect = require("chai").expect;
+const hub = require("../hub.js");
+
+let branch, remote;
+
+try {
+    branch =
+        process.env.BRANCH ||
+        process.env.CI_COMMIT_REF_NAME ||
+        require("git-branch").sync();
+} catch {
+    branch = "unknown";
+}
+
+try {
+    remote =
+        process.env.REMOTE_URL ||
+        require("child_process")
+            .execSync(`git config --get remote.origin.url`, {
+                encoding: "utf8",
+            })
+            .trim();
+} catch {
+    remote = "unknown";
+}
+
+describe("hub", () => {
+    describe("deployment", () => {
+        let deployment;
+
+        it("Should create a deployment model", async () => {
+            const repository = await hub.findRepository(remote);
+
+            deployment = await hub.startedDeployment(repository.id, branch);
+
+            expect(deployment.status).to.equal("started");
+        });
+
+        it("Should fail a deployment", async () => {
+            deployment = await hub.failedDeployment(deployment.id);
+
+            expect(deployment.status).to.equal("failed");
+        });
+
+        it("Should finish a deployment", async () => {
+            deployment = await hub.finishedDeployment(deployment.id);
+
+            expect(deployment.status).to.equal("completed");
+        });
+
+        after(() => {
+            hub.purgeDeployment(deployment.id);
+        });
+    });
+
+    describe("artifacts", () => {
+        let artifact;
+
+        it("Should create a artifact model", async () => {
+            const repository = await hub.findRepository(remote);
+
+            artifact = await hub.storeArtifact(
+                repository.id,
+                branch,
+                "pdf",
+                path.join(__dirname, "_fixtures/dummy.pdf"),
+            );
+
+            expect(artifact.file_path).to.not.be.empty;
+        });
+
+        after(() => {
+            hub.purgeArtifact(artifact.id);
+        });
+    });
+
+    describe("configurations", () => {
+        let configuration;
+
+        it("Should create a configuration model", async () => {
+            const repository = await hub.findRepository(remote);
+
+            configuration = await hub.getConfigurations(repository.id);
+
+            expect(configuration).to.not.be.undefined;
+        });
+    });
+});

package/cli.js

@@ -1,5 +1,19 @@
 #!/usr/bin/env node
 
+const path = require("path");
+const { copyFileSync, existsSync } = require("fs");
+
+// Copy env.example if .env doesnt exist
+if (
+    existsSync(path.join(__dirname, ".env.example")) &&
+    !existsSync(path.join(__dirname, ".env"))
+) {
+    copyFileSync(
+        path.join(__dirname, ".env.example"),
+        path.join(__dirname, ".env"),
+    );
+}
+
 process.env.CWD = process.cwd();
 
 const _ = require("./globals.js");
@@ -89,6 +103,7 @@ const args = hideBin(process.argv);
             content: _.config.preset !== "external" && _.platform !== "python",
             deploy: _.config.preset === "permanent",
             origin: _.config.preset === "permanent",
+            package: _.config.preset === "permanent",
         };
 
         // Build commands array

package/commands/content.js

@@ -1,6 +1,9 @@
 const execSync = require("child_process").execSync;
+const fs = require("fs-extra");
 const utilities = require("./create/libs/utilities");
 const _ = require("../globals.js");
+const { getConfigurations, findRepository } = require("../hub.js");
+const glob = require("glob");
 
 module.exports = [
     "content",
@@ -12,7 +15,7 @@ module.exports = [
             type: "boolean",
         });
     },
-    (argv) => {
+    async (argv) => {
         if (argv.init) {
             const stringify = JSON.stringify(
                 {
@@ -33,6 +36,38 @@ module.exports = [
             );
         } else {
             _.command("core", `npm run content`);
+
+            if (process.env.HUB_URL) {
+                console.log(`Syncing branch configurations from Hub...`);
+                // TODO: Fetch specific values and map to core config vlaues
+                // TODO: Add migration step of test ui to docs
+                const repository = await findRepository(_.remote);
+                const configurations = await getConfigurations(repository?.id);
+
+                // Remove existing hub configuration files
+                glob.sync("hub.*.*.json").forEach((file) =>
+                    fs.removeSync(file),
+                );
+
+                configurations?.forEach(({ config, id, branch }) => {
+                    const filePath = `hub.${branch}.${id}.json`;
+
+                    fs.writeFileSync(
+                        filePath,
+                        JSON.stringify(
+                            {
+                                attributes: {
+                                    targets: {
+                                        [branch]: config,
+                                    },
+                                },
+                            },
+                            null,
+                            4,
+                        ),
+                    );
+                });
+            }
         }
     },
 ];

package/commands/deploy.js

@@ -1,4 +1,10 @@
 const _ = require("../globals.js");
+const {
+    startedDeployment,
+    finishedDeployment,
+    failedDeployment,
+    findRepository,
+} = require("../hub.js");
 
 const execSync = require("child_process").execSync;
 
@@ -6,26 +12,42 @@ module.exports = [
     "deploy",
     "deploys the repo",
     () => {},
-    () => {
-        if (
-            _.platform === "laravel" ||
-            _.platform === "wordpress" ||
-            _.platform === "drupal" ||
-            _.platform === "craftcms" ||
-            _.platform === "adonis" ||
-            _.platform === "python"
-        ) {
-            _.up(() =>
-                execSync(
-                    `source ${__dirname}/../intercept.sh && /bin/bash ./_Scripts/deploy.sh`,
-                    _.opts,
-                ),
-            );
-        } else {
-            _.command(
-                "core",
-                `${process.env.VERSION === "0" ? "xvfb-run " : ""}npm run deploy`,
-            );
+    async () => {
+        if (!_.coreConfig?.attributes?.deploy) {
+            console.log(`No deployment location configured for ${_.branch}`);
+            return;
         }
+
+        const repository = await findRepository(_.remote);
+        const deployment = await startedDeployment(repository?.id, _.branch);
+
+        try {
+            if (
+                _.platform === "laravel" ||
+                _.platform === "wordpress" ||
+                _.platform === "drupal" ||
+                _.platform === "craftcms" ||
+                _.platform === "adonis" ||
+                _.platform === "python"
+            ) {
+                _.up(() =>
+                    execSync(
+                        `source ${__dirname}/../intercept.sh && /bin/bash ./_Scripts/deploy.sh`,
+                        _.opts,
+                    ),
+                );
+            } else {
+                _.command(
+                    "core",
+                    `${process.env.VERSION === "0" ? "xvfb-run " : ""}npm run deploy`,
+                );
+            }
+        } catch (e) {
+            await failedDeployment(deployment?.id);
+
+            throw e;
+        }
+
+        await finishedDeployment(deployment?.id);
     },
 ];

package/commands/package.js

@@ -0,0 +1,51 @@
+const fs = require("fs-extra");
+const _ = require("../globals.js");
+const path = require("path");
+const { storeArtifact, findRepository } = require("../hub.js");
+const glob = require("glob");
+
+module.exports = [
+    "package",
+    "creates and transfers artifacts",
+    () => {},
+    async () => {
+        _.command("core", `npm run package`);
+
+        const repository = await findRepository(_.remote);
+
+        const artifactDirs = [
+            { dir: "_Zips/", type: "build" },
+            { dir: "_Pdfs/", type: "pdf" },
+        ];
+
+        for (const { dir, type } of artifactDirs) {
+            if (!fs.existsSync(dir)) {
+                console.log(`No artifacts found in ${dir}`);
+                continue;
+            }
+
+            // Store artifacts in Hub
+            const files = glob.sync(`${dir}**/*`, { nodir: true });
+            for (const file of files) {
+                const fileName = path.basename(file);
+
+                // Check if it's a screenshot in _Zips directory
+                const artifactType =
+                    type === "build" && fileName.includes("Screenshot")
+                        ? "screenshots"
+                        : type;
+
+                const res = await storeArtifact(
+                    repository?.id,
+                    _.branch,
+                    artifactType,
+                    file,
+                );
+
+                if (res) {
+                    console.log(`Stored ${artifactType} artifact: ${fileName}`);
+                }
+            }
+        }
+    },
+];

package/globals.js

@@ -127,6 +127,7 @@ var exec;
 var running;
 var services;
 var branch;
+var remote;
 let vscodeSettings = {};
 var diagnosis = "4.0.0";
 var opts = { encoding: "utf8", stdio: "inherit", shell: "/bin/bash" };
@@ -152,6 +153,18 @@ try {
     branch = "unknown";
 }
 
+try {
+    remote =
+        process.env.REMOTE_URL ||
+        require("child_process")
+            .execSync(`git config --get remote.origin.url`, {
+                encoding: "utf8",
+            })
+            .trim();
+} catch {
+    remote = "unknown";
+}
+
 const coreConfig = getCoreMergedConfigs();
 
 try {
@@ -756,6 +769,7 @@ module.exports = {
     volumes: volumes.map((d) => `${repoSafe}_${d}`),
     repo,
     branch,
+    remote,
     repoSafe,
     pkg,
     docker,
@@ -763,6 +777,7 @@ module.exports = {
     running,
     opts,
     users,
+    coreConfig,
     ports: {
         async set() {
             if (!running) {

package/hub.js

@@ -0,0 +1,159 @@
+require("dotenv").config({
+    path: `${__dirname}/.env`,
+    quiet: true,
+    override: true,
+});
+
+const axios = require("axios");
+const FormData = require("form-data");
+const fs = require("fs");
+
+const baseUrl = process.env.HUB_URL;
+const headers = {
+    headers: {
+        Authorization: `Bearer ${process.env.HUB_TOKEN}`,
+    },
+};
+
+module.exports = {
+    async startedDeployment(repositoryId, branch) {
+        try {
+            return (
+                await axios.post(
+                    `${baseUrl}/api/services/deployments`,
+                    {
+                        repository_id: repositoryId,
+                        branch,
+                        status: "started",
+                    },
+                    headers,
+                )
+            ).data.data;
+        } catch (e) {
+            console.log(
+                `Deployment Hub: Error logging deployment start in hub: ${e.message}`,
+            );
+            process.exit(1);
+        }
+    },
+    async finishedDeployment(deploymentId) {
+        try {
+            return (
+                await axios.patch(
+                    `${baseUrl}/api/services/deployments/${deploymentId}`,
+                    {
+                        status: "completed",
+                    },
+                    headers,
+                )
+            ).data.data;
+        } catch (e) {
+            console.log(
+                `Deployment Hub: Error logging deployment finish in hub: ${e.message}`,
+            );
+            process.exit(1);
+        }
+    },
+    async failedDeployment(deploymentId) {
+        try {
+            return (
+                await axios.patch(
+                    `${baseUrl}/api/services/deployments/${deploymentId}`,
+                    {
+                        status: "failed",
+                    },
+                    headers,
+                )
+            ).data.data;
+        } catch (e) {
+            console.log(
+                `Error logging deployment failure in hub: ${e.message}`,
+            );
+            process.exit(1);
+        }
+    },
+    async purgeDeployment(deploymentId) {
+        try {
+            await axios.delete(
+                `${baseUrl}/api/services/deployments/${deploymentId}`,
+                headers,
+            );
+        } catch (e) {
+            console.log(e.message);
+            process.exit(1);
+        }
+    },
+    async storeArtifact(repositoryId, branch, type, file) {
+        try {
+            const formData = new FormData();
+            formData.append("repository_id", repositoryId);
+            formData.append("branch", branch);
+            formData.append("type", type);
+            formData.append("file", fs.createReadStream(file));
+
+            return (
+                await axios.post(
+                    `${baseUrl}/api/services/artifacts`,
+                    formData,
+                    {
+                        headers: {
+                            ...headers.headers,
+                            ...formData.getHeaders(),
+                        },
+                    },
+                )
+            ).data.data;
+        } catch (e) {
+            console.log(
+                `Deployment Hub: Error storing artifact in hub: ${e.message}`,
+            );
+            process.exit(1);
+        }
+    },
+    async purgeArtifact(artifactId) {
+        try {
+            await axios.delete(
+                `${baseUrl}/api/services/artifacts/${artifactId}`,
+                headers,
+            );
+        } catch (e) {
+            console.log(e.message);
+            process.exit(1);
+        }
+    },
+    async getConfigurations(repositoryId) {
+        try {
+            return (
+                await axios.get(`${baseUrl}/api/services/configurations`, {
+                    ...headers,
+                    ...{
+                        params: {
+                            "filter[repository_id]": repositoryId,
+                        },
+                    },
+                })
+            ).data.data;
+        } catch (e) {
+            console.log(e.message);
+            process.exit(1);
+        }
+    },
+    async findRepository(remoteUrl) {
+        try {
+            return (
+                await axios.post(
+                    `${baseUrl}/api/services/repositories/find-or-create`,
+                    {
+                        remote_url: remoteUrl,
+                    },
+                    headers,
+                )
+            ).data.data;
+        } catch (e) {
+            console.log(
+                `Deployment Hub: Error finding repository: ${e.message}`,
+            );
+            process.exit(1);
+        }
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fishawack/lab-env",
-    "version": "5.0.0-beta.1",
+    "version": "5.0.0",
     "description": "Docker manager for FW",
     "main": "cli.js",
     "scripts": {
@@ -29,6 +29,8 @@
         "apache-md5": "^1.1.8",
         "axios": "^0.21.4",
         "chalk": "4.1.0",
+        "dotenv": "^17.2.3",
+        "form-data": "^4.0.4",
         "fs-extra": "^11.1.1",
         "generate-password": "^1.7.0",
         "get-port": "5.1.1",