#287 Refacror

2023-04-02 03:10:16 +02:00
parent 0b16df7731
commit 53e38336fb
9 changed files with 166 additions and 126 deletions
--- a/src/bin/keycloakify/BuildOptions.ts
+++ b/src/bin/keycloakify/BuildOptions.ts
@ -4,7 +4,8 @@ import { parse as urlParse } from "url";
 import { typeGuard } from "tsafe/typeGuard";
 import { symToStr } from "tsafe/symToStr";
 import { bundlers, getParsedPackageJson, type Bundler } from "./parsedPackageJson";
-import { getAppInputPath, getKeycloakBuildPath } from "./build-paths";
+import * as fs from "fs";
+import { join as pathJoin, sep as pathSep } from "path";

 /** Consolidated build option gathered form CLI arguments and config in package.json */
 export type BuildOptions = BuildOptions.Standalone | BuildOptions.ExternalAssets;
@ -21,10 +22,10 @@ export namespace BuildOptions {
        artifactId: string;
        bundler: Bundler;
        keycloakVersionDefaultAssets: string;
-        // Directory of your built react project. Defaults to {cwd}/build
-        appInputPath: string;
-        // Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak
-        keycloakBuildPath: string;
+        /** Directory of your built react project. Defaults to {cwd}/build */
+        reactAppBuildDirPath: string;
+        /** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
+        keycloakifyBuildDirPath: string;
        customUserAttributes: string[];
    };

@ -52,10 +53,10 @@ export namespace BuildOptions {
    }
 }

-export function readBuildOptions(params: { CNAME: string | undefined; isExternalAssetsCliParamProvided: boolean; isSilent: boolean }): BuildOptions {
-    const { CNAME, isExternalAssetsCliParamProvided, isSilent } = params;
+export function readBuildOptions(params: { projectDirPath: string; isExternalAssetsCliParamProvided: boolean; isSilent: boolean }): BuildOptions {
+    const { projectDirPath, isExternalAssetsCliParamProvided, isSilent } = params;

-    const parsedPackageJson = getParsedPackageJson();
+    const parsedPackageJson = getParsedPackageJson({ projectDirPath });

    const url = (() => {
        const { homepage } = parsedPackageJson;
@ -66,6 +67,16 @@ export function readBuildOptions(params: { CNAME: string | undefined; isExternal
            url = new URL(homepage);
        }

+        const CNAME = (() => {
+            const cnameFilePath = pathJoin(projectDirPath, "public", "CNAME");
+
+            if (!fs.existsSync(cnameFilePath)) {
+                return undefined;
+            }
+
+            return fs.readFileSync(cnameFilePath).toString("utf8");
+        })();
+
        if (CNAME !== undefined) {
            url = new URL(`https://${CNAME.replace(/\s+$/, "")}`);
        }
@ -134,8 +145,40 @@ export function readBuildOptions(params: { CNAME: string | undefined; isExternal
            extraThemeProperties,
            isSilent,
            "keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? "11.0.3",
-            appInputPath: getAppInputPath(),
-            keycloakBuildPath: getKeycloakBuildPath(),
+            "reactAppBuildDirPath": (() => {
+                let { reactAppBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
+
+                if (reactAppBuildDirPath === undefined) {
+                    return pathJoin(projectDirPath, "build");
+                }
+
+                if (pathSep === "\\") {
+                    reactAppBuildDirPath = reactAppBuildDirPath.replace(/\//g, pathSep);
+                }
+
+                if (reactAppBuildDirPath.startsWith(`.${pathSep}`)) {
+                    return pathJoin(projectDirPath, reactAppBuildDirPath);
+                }
+
+                return reactAppBuildDirPath;
+            })(),
+            "keycloakifyBuildDirPath": (() => {
+                let { keycloakifyBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
+
+                if (keycloakifyBuildDirPath === undefined) {
+                    return pathJoin(projectDirPath, "build_keycloak");
+                }
+
+                if (pathSep === "\\") {
+                    keycloakifyBuildDirPath = keycloakifyBuildDirPath.replace(/\//g, pathSep);
+                }
+
+                if (keycloakifyBuildDirPath.startsWith(`.${pathSep}`)) {
+                    return pathJoin(projectDirPath, keycloakifyBuildDirPath);
+                }
+
+                return keycloakifyBuildDirPath;
+            })(),
            "customUserAttributes": keycloakify.customUserAttributes ?? []
        };
    })();
--- a/src/bin/keycloakify/build-paths.ts
+++ b/src/bin/keycloakify/build-paths.ts
@ -1,72 +0,0 @@
-import * as fs from "fs";
-import { exclude } from "tsafe";
-import { crawl } from "../tools/crawl";
-import { pathJoin } from "../tools/pathJoin";
-import { getParsedPackageJson } from "./parsedPackageJson";
-
-const DEFAULT_APP_INPUT_PATH = "build";
-
-const DEFAULT_KEYCLOAK_BUILD_PATH = "build_keycloak";
-
-const THEME_SRC_DIR_BASENAME = "keycloak-theme";
-
-export const getReactProjectDirPath = () => process.cwd();
-
-export const getCnamePath = () => pathJoin(getReactProjectDirPath(), "public", "CNAME");
-
-const parseAppInputPath = (path?: string) => {
-    if (!path) {
-        return pathJoin(process.cwd(), DEFAULT_APP_INPUT_PATH);
-    } else if (path.startsWith("./")) {
-        return pathJoin(process.cwd(), path.replace("./", ""));
-    }
-    return path;
-};
-
-const parseKeycloakBuildPath = (path?: string) => {
-    if (!path) {
-        return pathJoin(process.cwd(), DEFAULT_KEYCLOAK_BUILD_PATH);
-    } else if (path.startsWith("./")) {
-        return pathJoin(process.cwd(), path.replace("./", ""));
-    }
-    return path;
-};
-
-export const getAppInputPath = () => {
-    return parseAppInputPath(getParsedPackageJson().keycloakify?.appInputPath);
-};
-
-export const getKeycloakBuildPath = () => {
-    return parseKeycloakBuildPath(getParsedPackageJson().keycloakify?.keycloakBuildPath);
-};
-export const getThemeSrcDirPath = () => {
-    const srcDirPath = pathJoin(getReactProjectDirPath(), "src");
-
-    const themeSrcDirPath: string | undefined = crawl(srcDirPath)
-        .map(fileRelativePath => {
-            const split = fileRelativePath.split(THEME_SRC_DIR_BASENAME);
-
-            if (split.length !== 2) {
-                return undefined;
-            }
-
-            return pathJoin(srcDirPath, split[0] + THEME_SRC_DIR_BASENAME);
-        })
-        .filter(exclude(undefined))[0];
-    if (themeSrcDirPath === undefined) {
-        if (fs.existsSync(pathJoin(srcDirPath, "login")) || fs.existsSync(pathJoin(srcDirPath, "account"))) {
-            return { "themeSrcDirPath": srcDirPath };
-        }
-        return { "themeSrcDirPath": undefined };
-    }
-
-    return { themeSrcDirPath };
-};
-
-export const getEmailThemeSrcDirPath = () => {
-    const { themeSrcDirPath } = getThemeSrcDirPath();
-
-    const emailThemeSrcDirPath = themeSrcDirPath === undefined ? undefined : pathJoin(themeSrcDirPath, "email");
-
-    return { emailThemeSrcDirPath };
-};
--- a/src/bin/keycloakify/keycloakify.ts
+++ b/src/bin/keycloakify/keycloakify.ts
@ -10,32 +10,25 @@ import { getCliOptions } from "../tools/cliOptions";
 import jar from "../tools/jar";
 import { assert } from "tsafe/assert";
 import { Equals } from "tsafe";
-import { getEmailThemeSrcDirPath } from "./build-paths";
-import { getCnamePath, getAppInputPath, getKeycloakBuildPath, getReactProjectDirPath } from "./build-paths";
+import { getEmailThemeSrcDirPath } from "../getSrcDirPath";

 export async function main() {
    const { isSilent, hasExternalAssets } = getCliOptions(process.argv.slice(2));
    const logger = getLogger({ isSilent });
    logger.log("🔏 Building the keycloak theme...⌚");

+    const projectDirPath = process.cwd();
+
    const buildOptions = readBuildOptions({
-        "CNAME": (() => {
-            const cnameFilePath = getCnamePath();
-
-            if (!fs.existsSync(cnameFilePath)) {
-                return undefined;
-            }
-
-            return fs.readFileSync(cnameFilePath).toString("utf8");
-        })(),
+        projectDirPath,
        "isExternalAssetsCliParamProvided": hasExternalAssets,
        "isSilent": isSilent
    });

    const { doBundlesEmailTemplate } = await generateKeycloakThemeResources({
-        keycloakThemeBuildingDirPath: buildOptions.keycloakBuildPath,
+        keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
        "emailThemeSrcDirPath": (() => {
-            const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath();
+            const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath({ projectDirPath });

            if (emailThemeSrcDirPath === undefined || !fs.existsSync(emailThemeSrcDirPath)) {
                return;
@ -43,13 +36,13 @@ export async function main() {

            return emailThemeSrcDirPath;
        })(),
-        "reactAppBuildDirPath": getAppInputPath(),
+        "reactAppBuildDirPath": buildOptions.reactAppBuildDirPath,
        buildOptions,
        "keycloakVersion": buildOptions.keycloakVersionDefaultAssets
    });

    const { jarFilePath } = generateJavaStackFiles({
-        keycloakThemeBuildingDirPath: buildOptions.keycloakBuildPath,
+        keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
        doBundlesEmailTemplate,
        buildOptions
    });
@ -61,7 +54,7 @@ export async function main() {
        case "keycloakify":
            logger.log("🫶 Let keycloakify do its thang");
            await jar({
-                "rootPath": pathJoin(buildOptions.keycloakBuildPath, "src", "main", "resources"),
+                "rootPath": pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources"),
                "version": buildOptions.version,
                "groupId": buildOptions.groupId,
                "artifactId": buildOptions.artifactId,
@ -70,7 +63,7 @@ export async function main() {
            break;
        case "mvn":
            logger.log("🫙 Run maven to deliver a jar");
-            child_process.execSync("mvn package", { "cwd": buildOptions.keycloakBuildPath });
+            child_process.execSync("mvn package", { "cwd": buildOptions.keycloakifyBuildDirPath });
            break;
        default:
            assert<Equals<typeof buildOptions.bundler, never>>(false);
@ -80,7 +73,7 @@ export async function main() {
    const containerKeycloakVersion = "20.0.1";

    generateStartKeycloakTestingContainer({
-        keycloakThemeBuildingDirPath: buildOptions.keycloakBuildPath,
+        keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
        "keycloakVersion": containerKeycloakVersion,
        buildOptions
    });
@ -88,7 +81,7 @@ export async function main() {
    logger.log(
        [
            "",
-            `✅ Your keycloak theme has been generated and bundled into ./${pathRelative(getReactProjectDirPath(), jarFilePath)} 🚀`,
+            `✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathRelative(projectDirPath, jarFilePath)} 🚀`,
            `It is to be placed in "/opt/keycloak/providers" in the container running a quay.io/keycloak/keycloak Docker image.`,
            "",
            //TODO: Restore when we find a good Helm chart for Keycloak.
@ -123,8 +116,8 @@ export async function main() {
            `To test your theme locally you can spin up a Keycloak ${containerKeycloakVersion} container image with the theme pre loaded by running:`,
            "",
            `👉 $ .${pathSep}${pathRelative(
-                getReactProjectDirPath(),
-                pathJoin(getKeycloakBuildPath(), generateStartKeycloakTestingContainer.basename)
+                projectDirPath,
+                pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
            )} 👈`,
            "",
            `Test with different Keycloak versions by editing the .sh file. see available versions here: https://quay.io/repository/keycloak/keycloak?tab=tags`,
--- a/src/bin/keycloakify/parsedPackageJson.ts
+++ b/src/bin/keycloakify/parsedPackageJson.ts
@ -4,10 +4,9 @@ import type { Equals } from "tsafe";
 import { z } from "zod";
 import { pathJoin } from "../tools/pathJoin";

-const reactProjectDirPath = process.cwd();
 export const bundlers = ["mvn", "keycloakify", "none"] as const;
 export type Bundler = (typeof bundlers)[number];
-type ParsedPackageJson = {
+export type ParsedPackageJson = {
    name: string;
    version: string;
    homepage?: string;
@ -22,8 +21,8 @@ type ParsedPackageJson = {
        groupId?: string;
        bundler?: Bundler;
        keycloakVersionDefaultAssets?: string;
-        appInputPath?: string;
-        keycloakBuildPath?: string;
+        reactAppBuildDirPath?: string;
+        keycloakifyBuildDirPath?: string;
        customUserAttributes?: string[];
        themeName?: string;
    };
@ -44,8 +43,8 @@ const zParsedPackageJson = z.object({
            "groupId": z.string().optional(),
            "bundler": z.enum(bundlers).optional(),
            "keycloakVersionDefaultAssets": z.string().optional(),
-            "appInputPath": z.string().optional(),
-            "keycloakBuildPath": z.string().optional(),
+            "reactAppBuildDirPath": z.string().optional(),
+            "keycloakifyBuildDirPath": z.string().optional(),
            "customUserAttributes": z.array(z.string()).optional(),
            "themeName": z.string().optional()
        })
@ -55,8 +54,11 @@ const zParsedPackageJson = z.object({
 assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();

 let parsedPackageJson: undefined | ReturnType<(typeof zParsedPackageJson)["parse"]>;
-export const getParsedPackageJson = () => {
-    if (parsedPackageJson) return parsedPackageJson;
-    parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(reactProjectDirPath, "package.json")).toString("utf8")));
+export function getParsedPackageJson(params: { projectDirPath: string }) {
+    const { projectDirPath } = params;
+    if (parsedPackageJson) {
+        return parsedPackageJson;
+    }
+    parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(projectDirPath, "package.json")).toString("utf8")));
    return parsedPackageJson;
-};
+}