keycloakify 10.0.0-rc.90 → 10.0.0-rc.91

package/src/bin/start-keycloak/appBuild.ts

@@ -1,16 +1,14 @@
 import * as child_process from "child_process";
 import { Deferred } from "evt/tools/Deferred";
 import { assert } from "tsafe/assert";
-import { is } from "tsafe/is";
 import type { BuildContext } from "../shared/buildContext";
-import * as fs from "fs";
-import { join as pathJoin } from "path";
+import chalk from "chalk";
+import { sep as pathSep, join as pathJoin } from "path";
 
 export type BuildContextLike = {
     projectDirPath: string;
     keycloakifyBuildDirPath: string;
-    bundler: "vite" | "webpack";
-    npmWorkspaceRootDirPath: string;
+    bundler: BuildContext["bundler"];
     projectBuildDirPath: string;
 };
 
@@ -21,95 +19,27 @@ export async function appBuild(params: {
 }): Promise<{ isAppBuildSuccess: boolean }> {
     const { buildContext } = params;
 
-    const { bundler } = buildContext;
-
-    const { command, args, cwd } = (() => {
-        switch (bundler) {
-            case "vite":
-                return {
-                    command: "npx",
-                    args: ["vite", "build"],
-                    cwd: buildContext.projectDirPath
-                };
-            case "webpack": {
-                for (const dirPath of [
-                    buildContext.projectDirPath,
-                    buildContext.npmWorkspaceRootDirPath
-                ]) {
-                    try {
-                        const parsedPackageJson = JSON.parse(
-                            fs
-                                .readFileSync(pathJoin(dirPath, "package.json"))
-                                .toString("utf8")
-                        );
-
-                        const [scriptName] =
-                            Object.entries(parsedPackageJson.scripts).find(
-                                ([, scriptValue]) => {
-                                    assert(is<string>(scriptValue));
-                                    if (
-                                        scriptValue.includes("webpack") &&
-                                        scriptValue.includes("--mode production")
-                                    ) {
-                                        return true;
-                                    }
-
-                                    if (
-                                        scriptValue.includes("react-scripts") &&
-                                        scriptValue.includes("build")
-                                    ) {
-                                        return true;
-                                    }
-
-                                    if (
-                                        scriptValue.includes("react-app-rewired") &&
-                                        scriptValue.includes("build")
-                                    ) {
-                                        return true;
-                                    }
-
-                                    if (
-                                        scriptValue.includes("craco") &&
-                                        scriptValue.includes("build")
-                                    ) {
-                                        return true;
-                                    }
-
-                                    if (
-                                        scriptValue.includes("ng") &&
-                                        scriptValue.includes("build")
-                                    ) {
-                                        return true;
-                                    }
-
-                                    return false;
-                                }
-                            ) ?? [];
-
-                        if (scriptName === undefined) {
-                            continue;
-                        }
-
-                        return {
-                            command: "npm",
-                            args: ["run", scriptName],
-                            cwd: dirPath
-                        };
-                    } catch {
-                        continue;
-                    }
-                }
+    switch (buildContext.bundler.type) {
+        case "vite":
+            return appBuild_vite({ buildContext });
+        case "webpack":
+            return appBuild_webpack({ buildContext });
+    }
+}
 
-                throw new Error(
-                    "Keycloakify was unable to determine which script is responsible for building the app."
-                );
-            }
-        }
-    })();
+async function appBuild_vite(params: {
+    buildContext: BuildContextLike;
+}): Promise<{ isAppBuildSuccess: boolean }> {
+    const { buildContext } = params;
+
+    assert(buildContext.bundler.type === "vite");
 
     const dResult = new Deferred<{ isSuccess: boolean }>();
 
-    const child = child_process.spawn(command, args, { cwd, shell: true });
+    const child = child_process.spawn("npx", ["vite", "build"], {
+        cwd: buildContext.projectDirPath,
+        shell: true
+    });
 
     child.stdout.on("data", data => {
         if (data.toString("utf8").includes("gzip:")) {
@@ -127,3 +57,113 @@ export async function appBuild(params: {
 
     return { isAppBuildSuccess: isSuccess };
 }
+
+async function appBuild_webpack(params: {
+    buildContext: BuildContextLike;
+}): Promise<{ isAppBuildSuccess: boolean }> {
+    const { buildContext } = params;
+
+    assert(buildContext.bundler.type === "webpack");
+
+    const entries = Object.entries(buildContext.bundler.packageJsonScripts).filter(
+        ([, scriptCommand]) => scriptCommand.includes("keycloakify build")
+    );
+
+    if (entries.length === 0) {
+        console.log(
+            chalk.red(
+                [
+                    `You should have a script in your package.json at ${buildContext.bundler.packageJsonDirPath}`,
+                    `that includes the 'keycloakify build' command`
+                ].join(" ")
+            )
+        );
+        process.exit(-1);
+    }
+
+    const entry =
+        entries.length === 1
+            ? entries[0]
+            : entries.find(([scriptName]) => scriptName === "build-keycloak-theme");
+
+    if (entry === undefined) {
+        console.log(
+            chalk.red(
+                "There's multiple candidate script for building your app, name one 'build-keycloak-theme'"
+            )
+        );
+        process.exit(-1);
+    }
+
+    const [scriptName, scriptCommand] = entry;
+
+    const { appBuildSubCommands } = (() => {
+        const appBuildSubCommands: string[] = [];
+
+        for (const subCmd of scriptCommand.split("&&").map(s => s.trim())) {
+            if (subCmd.includes("keycloakify build")) {
+                break;
+            }
+
+            appBuildSubCommands.push(subCmd);
+        }
+
+        return { appBuildSubCommands };
+    })();
+
+    if (appBuildSubCommands.length === 0) {
+        console.log(
+            chalk.red(
+                `Your ${scriptName} script should look like "... && keycloakify build ..."`
+            )
+        );
+        process.exit(-1);
+    }
+
+    for (const subCommand of appBuildSubCommands) {
+        const dIsSuccess = new Deferred<boolean>();
+
+        child_process.exec(
+            subCommand,
+            {
+                cwd: buildContext.bundler.packageJsonDirPath,
+                env: {
+                    ...process.env,
+                    PATH: (() => {
+                        const separator = pathSep === "/" ? ":" : ";";
+
+                        return [
+                            pathJoin(
+                                buildContext.bundler.packageJsonDirPath,
+                                "node_modules",
+                                ".bin"
+                            ),
+                            ...(process.env.PATH ?? "").split(separator)
+                        ].join(separator);
+                    })()
+                }
+            },
+            (error, stdout, stderr) => {
+                if (error) {
+                    dIsSuccess.resolve(false);
+
+                    console.log(chalk.red(`Error running: '${subCommand}'`));
+                    console.log(stdout);
+                    console.log(stderr);
+
+                    return;
+                }
+
+                dIsSuccess.resolve(true);
+            }
+        );
+
+        const isSuccess = await dIsSuccess.pr;
+
+        if (!isSuccess) {
+            return { isAppBuildSuccess: false };
+        }
+    }
+
+    return { isAppBuildSuccess: true };
+}

package/src/bin/start-keycloak/keycloakifyBuild.ts

@@ -7,7 +7,6 @@ import type { BuildContext } from "../shared/buildContext";
 export type BuildContextLike = {
     projectDirPath: string;
     keycloakifyBuildDirPath: string;
-    bundler: "vite" | "webpack";
 };
 
 assert<BuildContext extends BuildContextLike ? true : false>();

package/src/bin/start-keycloak/start-keycloak.ts

@@ -121,7 +121,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
         if (!isAppBuildSuccess) {
             console.log(
                 chalk.red(
-                    `App build failed, exiting. Try running 'npm run build' and see what's wrong.`
+                    `App build failed, exiting. Try building your app (e.g 'npm run build') and see what's wrong.`
                 )
             );
             process.exit(1);

package/src/bin/tools/{downloadAndExtractArchive/downloadAndExtractArchive.ts → downloadAndExtractArchive.ts}

@@ -1,12 +1,12 @@
-import fetch from "make-fetch-happen";
+import fetch, { type FetchOptions } from "make-fetch-happen";
 import { mkdir, unlink, writeFile, readdir, readFile } from "fs/promises";
 import { dirname as pathDirname, join as pathJoin } from "path";
 import { assert } from "tsafe/assert";
-import { extractArchive } from "../extractArchive";
-import { existsAsync } from "../fs.existsAsync";
-import { getProxyFetchOptions } from "./fetchProxyOptions";
+import { extractArchive } from "./extractArchive";
+import { existsAsync } from "./fs.existsAsync";
+
 import * as crypto from "crypto";
-import { rm } from "../fs.rm";
+import { rm } from "./fs.rm";
 
 export async function downloadAndExtractArchive(params: {
     url: string;
@@ -20,15 +20,10 @@ export async function downloadAndExtractArchive(params: {
         }) => Promise<void>;
     }) => Promise<void>;
     cacheDirPath: string;
-    npmWorkspaceRootDirPath: string;
+    fetchOptions: FetchOptions | undefined;
 }): Promise<{ extractedDirPath: string }> {
-    const {
-        url,
-        uniqueIdOfOnOnArchiveFile,
-        onArchiveFile,
-        cacheDirPath,
-        npmWorkspaceRootDirPath
-    } = params;
+    const { url, uniqueIdOfOnOnArchiveFile, onArchiveFile, cacheDirPath, fetchOptions } =
+        params;
 
     const archiveFileBasename = url.split("?")[0].split("/").reverse()[0];
 
@@ -55,10 +50,7 @@ export async function downloadAndExtractArchive(params: {
 
         await mkdir(pathDirname(archiveFilePath), { recursive: true });
 
-        const response = await fetch(
-            url,
-            await getProxyFetchOptions({ npmWorkspaceRootDirPath })
-        );
+        const response = await fetch(url, fetchOptions);
 
         response.body?.setMaxListeners(Number.MAX_VALUE);
         assert(typeof response.body !== "undefined" && response.body != null);

package/src/bin/tools/{downloadAndExtractArchive/fetchProxyOptions.ts → fetchProxyOptions.ts}

@@ -1,61 +1,40 @@
-import { exec as execCallback } from "child_process";
-import { readFile } from "fs/promises";
 import { type FetchOptions } from "make-fetch-happen";
-import { promisify } from "util";
-
-function ensureArray<T>(arg0: T | T[]) {
-    return Array.isArray(arg0) ? arg0 : typeof arg0 === "undefined" ? [] : [arg0];
-}
-
-function ensureSingleOrNone<T>(arg0: T | T[]) {
-    if (!Array.isArray(arg0)) return arg0;
-    if (arg0.length === 0) return undefined;
-    if (arg0.length === 1) return arg0[0];
-    throw new Error(
-        "Illegal configuration, expected a single value but found multiple: " +
-            arg0.map(String).join(", ")
-    );
-}
-
-type NPMConfig = Record<string, string | string[]>;
-
-/**
- * Get npm configuration as map
- */
-async function getNmpConfig(params: { npmWorkspaceRootDirPath: string }) {
-    const { npmWorkspaceRootDirPath } = params;
-
-    const exec = promisify(execCallback);
-
-    const stdout = await exec("npm config get", {
-        encoding: "utf8",
-        cwd: npmWorkspaceRootDirPath
-    }).then(({ stdout }) => stdout);
-
-    const npmConfigReducer = (cfg: NPMConfig, [key, value]: [string, string]) =>
-        key in cfg
-            ? { ...cfg, [key]: [...ensureArray(cfg[key]), value] }
-            : { ...cfg, [key]: value };
-
-    return stdout
-        .split("\n")
-        .filter(line => !line.startsWith(";"))
-        .map(line => line.trim())
-        .map(line => line.split("=", 2) as [string, string])
-        .reduce(npmConfigReducer, {} as NPMConfig);
-}
+import * as child_process from "child_process";
+import * as fs from "fs";
 
 export type ProxyFetchOptions = Pick<
     FetchOptions,
     "proxy" | "noProxy" | "strictSSL" | "cert" | "ca"
 >;
 
-export async function getProxyFetchOptions(params: {
-    npmWorkspaceRootDirPath: string;
-}): Promise<ProxyFetchOptions> {
-    const { npmWorkspaceRootDirPath } = params;
-
-    const cfg = await getNmpConfig({ npmWorkspaceRootDirPath });
+export function getProxyFetchOptions(params: {
+    npmConfigGetCwd: string;
+}): ProxyFetchOptions {
+    const { npmConfigGetCwd } = params;
+
+    const cfg = (() => {
+        const output = child_process
+            .execSync("npm config get", {
+                cwd: npmConfigGetCwd
+            })
+            .toString("utf8");
+
+        return output
+            .split("\n")
+            .filter(line => !line.startsWith(";"))
+            .map(line => line.trim())
+            .map(line => line.split("=", 2) as [string, string])
+            .reduce(
+                (
+                    cfg: Record<string, string | string[]>,
+                    [key, value]: [string, string]
+                ) =>
+                    key in cfg
+                        ? { ...cfg, [key]: [...ensureArray(cfg[key]), value] }
+                        : { ...cfg, [key]: value },
+                {}
+            );
+    })();
 
     const proxy = ensureSingleOrNone(cfg["https-proxy"] ?? cfg["proxy"]);
     const noProxy = cfg["noproxy"] ?? cfg["no-proxy"];
@@ -71,17 +50,16 @@ export async function getProxyFetchOptions(params: {
 
     if (typeof cafile !== "undefined" && cafile !== "null") {
         ca.push(
-            ...(await (async () => {
-                function chunks<T>(arr: T[], size: number = 2) {
-                    return arr
-                        .map((_, i) => i % size == 0 && arr.slice(i, i + size))
-                        .filter(Boolean) as T[][];
-                }
-
-                const cafileContent = await readFile(cafile, "utf-8");
+            ...(() => {
+                const cafileContent = fs.readFileSync(cafile).toString("utf8");
 
                 const newLinePlaceholder = "NEW_LINE_PLACEHOLDER_xIsPsK23svt";
 
+                const chunks = <T>(arr: T[], size: number = 2) =>
+                    arr
+                        .map((_, i) => i % size == 0 && arr.slice(i, i + size))
+                        .filter(Boolean) as T[][];
+
                 return chunks(cafileContent.split(/(-----END CERTIFICATE-----)/), 2).map(
                     ca =>
                         ca
@@ -90,7 +68,7 @@ export async function getProxyFetchOptions(params: {
                             .replace(new RegExp(`^${newLinePlaceholder}`), "")
                             .replace(new RegExp(newLinePlaceholder, "g"), "\\n")
                 );
-            })())
+            })()
         );
     }
 
@@ -102,3 +80,17 @@ export async function getProxyFetchOptions(params: {
         ca: ca.length === 0 ? undefined : ca
     };
 }
+
+function ensureArray<T>(arg0: T | T[]) {
+    return Array.isArray(arg0) ? arg0 : typeof arg0 === "undefined" ? [] : [arg0];
+}
+
+function ensureSingleOrNone<T>(arg0: T | T[]) {
+    if (!Array.isArray(arg0)) return arg0;
+    if (arg0.length === 0) return undefined;
+    if (arg0.length === 1) return arg0[0];
+    throw new Error(
+        "Illegal configuration, expected a single value but found multiple: " +
+            arg0.map(String).join(", ")
+    );
+}