Build rework checkpoint

2024-06-10 07:57:12 +02:00
parent 9bbc7cc651
commit 84c774503d
13 changed files with 159 additions and 303 deletions
--- a/src/bin/keycloakify/buildJars/buildJar.ts
+++ b/src/bin/keycloakify/buildJars/buildJar.ts
@ -32,12 +32,14 @@ export async function buildJar(params: {
    jarFileBasename: string;
    keycloakAccountV1Version: KeycloakAccountV1Version;
    keycloakThemeAdditionalInfoExtensionVersion: KeycloakThemeAdditionalInfoExtensionVersion;
+    resourcesDirPath: string;
    buildContext: BuildContextLike;
 }): Promise<void> {
    const {
        jarFileBasename,
        keycloakAccountV1Version,
        keycloakThemeAdditionalInfoExtensionVersion,
+        resourcesDirPath,
        buildContext
    } = params;

@ -57,7 +59,7 @@ export async function buildJar(params: {

            if (
                fileRelativePath ===
-                getMetaInfKeycloakThemesJsonFilePath({ keycloakifyBuildDirPath: "." })
+                getMetaInfKeycloakThemesJsonFilePath({ resourcesDirPath: "." })
            ) {
                return { modifiedSourceCode: sourceCode };
            }
@ -65,7 +67,7 @@ export async function buildJar(params: {
            for (const themeName of [...buildContext.themeNames, accountV1ThemeName]) {
                if (
                    isInside({
-                        dirPath: pathJoin("src", "main", "resources", "theme", themeName),
+                        dirPath: pathJoin("theme", themeName),
                        filePath: fileRelativePath
                    })
                ) {
@ -87,13 +89,7 @@ export async function buildJar(params: {

                      if (
                          isInside({
-                              dirPath: pathJoin(
-                                  "src",
-                                  "main",
-                                  "resources",
-                                  "theme",
-                                  accountV1ThemeName
-                              ),
+                              dirPath: pathJoin("theme", accountV1ThemeName),
                              filePath: fileRelativePath
                          })
                      ) {
@ -103,7 +99,7 @@ export async function buildJar(params: {
                      if (
                          fileRelativePath ===
                          getMetaInfKeycloakThemesJsonFilePath({
-                              keycloakifyBuildDirPath: "."
+                              resourcesDirPath: "."
                          })
                      ) {
                          const keycloakThemesJsonParsed = JSON.parse(
@ -128,15 +124,7 @@ export async function buildJar(params: {
                      for (const themeName of buildContext.themeNames) {
                          if (
                              fileRelativePath ===
-                              pathJoin(
-                                  "src",
-                                  "main",
-                                  "resources",
-                                  "theme",
-                                  themeName,
-                                  "account",
-                                  "theme.properties"
-                              )
+                              pathJoin("theme", themeName, "account", "theme.properties")
                          ) {
                              const modifiedSourceCode = Buffer.from(
                                  sourceCode
@ -160,8 +148,8 @@ export async function buildJar(params: {
                  };

        transformCodebase({
-            srcDirPath: buildContext.keycloakifyBuildDirPath,
-            destDirPath: keycloakifyBuildTmpDirPath,
+            srcDirPath: resourcesDirPath,
+            destDirPath: pathJoin(keycloakifyBuildTmpDirPath, "src", "main", "resources"),
            transformSourceCode: params => {
                const resultCommon = transformCodebase_common(params);

--- a/src/bin/keycloakify/buildJars/buildJars.ts
+++ b/src/bin/keycloakify/buildJars/buildJars.ts
@ -8,7 +8,7 @@ import { getKeycloakVersionRangeForJar } from "./getKeycloakVersionRangeForJar";
 import { buildJar, BuildContextLike as BuildContextLike_buildJar } from "./buildJar";
 import type { BuildContext } from "../../shared/buildContext";
 import { getJarFileBasename } from "../../shared/getJarFileBasename";
-import { readMetaInfKeycloakThemes } from "../../shared/metaInfKeycloakThemes";
+import { readMetaInfKeycloakThemes_fromResourcesDirPath } from "../../shared/metaInfKeycloakThemes";
 import { accountV1ThemeName } from "../../shared/constants";

 export type BuildContextLike = BuildContextLike_buildJar & {
@ -18,12 +18,13 @@ export type BuildContextLike = BuildContextLike_buildJar & {
 assert<BuildContext extends BuildContextLike ? true : false>();

 export async function buildJars(params: {
+    resourcesDirPath: string;
    buildContext: BuildContextLike;
 }): Promise<void> {
-    const { buildContext } = params;
+    const { resourcesDirPath, buildContext } = params;

-    const doesImplementAccountTheme = readMetaInfKeycloakThemes({
-        keycloakifyBuildDirPath: buildContext.keycloakifyBuildDirPath
+    const doesImplementAccountTheme = readMetaInfKeycloakThemes_fromResourcesDirPath({
+        resourcesDirPath: buildContext.keycloakifyBuildDirPath
    }).themes.some(({ name }) => name === accountV1ThemeName);

    await Promise.all(
@ -71,6 +72,7 @@ export async function buildJars(params: {
                                jarFileBasename,
                                keycloakAccountV1Version,
                                keycloakThemeAdditionalInfoExtensionVersion,
+                                resourcesDirPath,
                                buildContext
                            })
                    )
--- a/src/bin/keycloakify/generateSrcMainResources/bringInAccountV1.ts
+++ b/src/bin/keycloakify/generateSrcMainResources/bringInAccountV1.ts
@ -13,13 +13,15 @@ import { transformCodebase } from "../../tools/transformCodebase";
 export type BuildContextLike = {
    cacheDirPath: string;
    npmWorkspaceRootDirPath: string;
-    keycloakifyBuildDirPath: string;
 };

 assert<BuildContext extends BuildContextLike ? true : false>();

-export async function bringInAccountV1(params: { buildContext: BuildContextLike }) {
-    const { buildContext } = params;
+export async function bringInAccountV1(params: {
+    resourcesDirPath: string;
+    buildContext: BuildContextLike;
+}) {
+    const { resourcesDirPath, buildContext } = params;

    const { defaultThemeDirPath } = await downloadKeycloakDefaultTheme({
        keycloakVersion: lastKeycloakVersionWithAccountV1,
@ -27,10 +29,7 @@ export async function bringInAccountV1(params: { buildContext: BuildContextLike
    });

    const accountV1DirPath = pathJoin(
-        buildContext.keycloakifyBuildDirPath,
-        "src",
-        "main",
-        "resources",
+        resourcesDirPath,
        "theme",
        accountV1ThemeName,
        "account"
--- a/src/bin/keycloakify/generateSrcMainResources/generateSrcMainResources.ts
+++ b/src/bin/keycloakify/generateSrcMainResources/generateSrcMainResources.ts
@ -5,6 +5,8 @@ import {
    type BuildContextLike as BuildContextLike_generateSrcMainResourcesForMainTheme
 } from "./generateSrcMainResourcesForMainTheme";
 import { generateSrcMainResourcesForThemeVariant } from "./generateSrcMainResourcesForThemeVariant";
+import fs from "fs";
+import { rmSync } from "../../tools/fs.rmSync";

 export type BuildContextLike = BuildContextLike_generateSrcMainResourcesForMainTheme & {
    themeNames: string[];
@ -14,21 +16,27 @@ assert<BuildContext extends BuildContextLike ? true : false>();

 export async function generateSrcMainResources(params: {
    buildContext: BuildContextLike;
+    resourcesDirPath: string;
 }): Promise<void> {
-    const { buildContext } = params;
+    const { resourcesDirPath, buildContext } = params;

    const [themeName, ...themeVariantNames] = buildContext.themeNames;

+    if (fs.existsSync(resourcesDirPath)) {
+        rmSync(resourcesDirPath, { recursive: true });
+    }
+
    await generateSrcMainResourcesForMainTheme({
+        resourcesDirPath,
        themeName,
        buildContext
    });

    for (const themeVariantName of themeVariantNames) {
        generateSrcMainResourcesForThemeVariant({
+            resourcesDirPath,
            themeName,
-            themeVariantName,
-            buildContext
+            themeVariantName
        });
    }
 }
--- a/src/bin/keycloakify/generateSrcMainResources/generateSrcMainResourcesForMainTheme.ts
+++ b/src/bin/keycloakify/generateSrcMainResources/generateSrcMainResourcesForMainTheme.ts
@ -43,14 +43,10 @@ import { escapeStringForPropertiesFile } from "../../tools/escapeStringForProper
 export type BuildContextLike = BuildContextLike_kcContextExclusionsFtlCode &
    BuildContextLike_downloadKeycloakStaticResources &
    BuildContextLike_bringInAccountV1 & {
-        bundler: "vite" | "webpack";
        extraThemeProperties: string[] | undefined;
        loginThemeResourcesFromKeycloakVersion: string;
-        projectBuildDirPath: string;
-        assetsDirPath: string;
-        urlPathname: string | undefined;
        projectDirPath: string;
-        keycloakifyBuildDirPath: string;
+        projectBuildDirPath: string;
        environmentVariables: { name: string; default: string }[];
    };

@ -58,9 +54,10 @@ assert<BuildContext extends BuildContextLike ? true : false>();

 export async function generateSrcMainResourcesForMainTheme(params: {
    themeName: string;
+    resourcesDirPath: string;
    buildContext: BuildContextLike;
 }): Promise<void> {
-    const { themeName, buildContext } = params;
+    const { themeName, resourcesDirPath, buildContext } = params;

    const { themeSrcDirPath } = getThemeSrcDirPath({
        projectDirPath: buildContext.projectDirPath
@ -68,15 +65,7 @@ export async function generateSrcMainResourcesForMainTheme(params: {

    const getThemeTypeDirPath = (params: { themeType: ThemeType | "email" }) => {
        const { themeType } = params;
-        return pathJoin(
-            buildContext.keycloakifyBuildDirPath,
-            "src",
-            "main",
-            "resources",
-            "theme",
-            themeName,
-            themeType
-        );
+        return pathJoin(resourcesDirPath, "theme", themeName, themeType);
    };

    const cssGlobalsToDefine: Record<string, string> = {};
@ -207,8 +196,6 @@ export async function generateSrcMainResourcesForMainTheme(params: {
        ].forEach(pageId => {
            const { ftlCode } = generateFtlFilesCode({ pageId });

-            fs.mkdirSync(themeTypeDirPath, { recursive: true });
-
            fs.writeFileSync(
                pathJoin(themeTypeDirPath, pageId),
                Buffer.from(ftlCode, "utf8")
@ -291,6 +278,7 @@ export async function generateSrcMainResourcesForMainTheme(params: {

    if (implementedThemeTypes.account) {
        await bringInAccountV1({
+            resourcesDirPath,
            buildContext
        });
    }
@ -313,7 +301,7 @@ export async function generateSrcMainResourcesForMainTheme(params: {
        }

        writeMetaInfKeycloakThemes({
-            keycloakifyBuildDirPath: buildContext.keycloakifyBuildDirPath,
+            resourcesDirPath,
            metaInfKeycloakThemes
        });
    }
--- a/src/bin/keycloakify/generateSrcMainResources/generateSrcMainResourcesForThemeVariant.ts
+++ b/src/bin/keycloakify/generateSrcMainResources/generateSrcMainResourcesForThemeVariant.ts
@ -2,7 +2,7 @@ import { join as pathJoin, extname as pathExtname, sep as pathSep } from "path";
 import { transformCodebase } from "../../tools/transformCodebase";
 import type { BuildContext } from "../../shared/buildContext";
 import {
-    readMetaInfKeycloakThemes,
+    readMetaInfKeycloakThemes_fromResourcesDirPath,
    writeMetaInfKeycloakThemes
 } from "../../shared/metaInfKeycloakThemes";
 import { assert } from "tsafe/assert";
@ -14,20 +14,13 @@ export type BuildContextLike = {
 assert<BuildContext extends BuildContextLike ? true : false>();

 export function generateSrcMainResourcesForThemeVariant(params: {
+    resourcesDirPath: string;
    themeName: string;
    themeVariantName: string;
-    buildContext: BuildContextLike;
 }) {
-    const { themeName, themeVariantName, buildContext } = params;
+    const { resourcesDirPath, themeName, themeVariantName } = params;

-    const mainThemeDirPath = pathJoin(
-        buildContext.keycloakifyBuildDirPath,
-        "src",
-        "main",
-        "resources",
-        "theme",
-        themeName
-    );
+    const mainThemeDirPath = pathJoin(resourcesDirPath, "theme", themeName);

    transformCodebase({
        srcDirPath: mainThemeDirPath,
@ -57,9 +50,10 @@ export function generateSrcMainResourcesForThemeVariant(params: {
    });

    {
-        const updatedMetaInfKeycloakThemes = readMetaInfKeycloakThemes({
-            keycloakifyBuildDirPath: buildContext.keycloakifyBuildDirPath
-        });
+        const updatedMetaInfKeycloakThemes =
+            readMetaInfKeycloakThemes_fromResourcesDirPath({
+                resourcesDirPath
+            });

        updatedMetaInfKeycloakThemes.themes.push({
            name: themeVariantName,
@ -73,7 +67,7 @@ export function generateSrcMainResourcesForThemeVariant(params: {
        });

        writeMetaInfKeycloakThemes({
-            keycloakifyBuildDirPath: buildContext.keycloakifyBuildDirPath,
+            resourcesDirPath,
            metaInfKeycloakThemes: updatedMetaInfKeycloakThemes
        });
    }
--- a/src/bin/keycloakify/generateStartKeycloakTestingContainer.ts
+++ b/src/bin/keycloakify/generateStartKeycloakTestingContainer.ts
@ -1,74 +0,0 @@
-import * as fs from "fs";
-import {
-    join as pathJoin,
-    relative as pathRelative,
-    basename as pathBasename
-} from "path";
-import { assert } from "tsafe/assert";
-import type { BuildContext } from "../shared/buildContext";
-import { accountV1ThemeName } from "../shared/constants";
-
-export type BuildContextLike = {
-    keycloakifyBuildDirPath: string;
-    themeNames: string[];
-};
-
-assert<BuildContext extends BuildContextLike ? true : false>();
-
-generateStartKeycloakTestingContainer.basename = "start_keycloak_testing_container.sh";
-
-const containerName = "keycloak-testing-container";
-const keycloakVersion = "24.0.4";
-
-/** Files for being able to run a hot reload keycloak container */
-export function generateStartKeycloakTestingContainer(params: {
-    jarFilePath: string;
-    doesImplementAccountTheme: boolean;
-    buildContext: BuildContextLike;
-}) {
-    const { jarFilePath, doesImplementAccountTheme, buildContext } = params;
-
-    const themeRelativeDirPath = pathJoin("src", "main", "resources", "theme");
-
-    fs.writeFileSync(
-        pathJoin(
-            buildContext.keycloakifyBuildDirPath,
-            generateStartKeycloakTestingContainer.basename
-        ),
-        Buffer.from(
-            [
-                "#!/usr/bin/env bash",
-                "",
-                `docker rm ${containerName} || true`,
-                "",
-                `cd "${buildContext.keycloakifyBuildDirPath}"`,
-                "",
-                "docker run \\",
-                "   -p 8080:8080 \\",
-                `   --name ${containerName} \\`,
-                "   -e KEYCLOAK_ADMIN=admin \\",
-                "   -e KEYCLOAK_ADMIN_PASSWORD=admin \\",
-                `   -v "${pathJoin(
-                    "$(pwd)",
-                    pathRelative(buildContext.keycloakifyBuildDirPath, jarFilePath)
-                )}":"/opt/keycloak/providers/${pathBasename(jarFilePath)}" \\`,
-                [
-                    ...(doesImplementAccountTheme ? [accountV1ThemeName] : []),
-                    ...buildContext.themeNames
-                ].map(
-                    themeName =>
-                        `   -v "${pathJoin(
-                            "$(pwd)",
-                            themeRelativeDirPath,
-                            themeName
-                        ).replace(/\\/g, "/")}":"/opt/keycloak/themes/${themeName}":rw \\`
-                ),
-                `   -it quay.io/keycloak/keycloak:${keycloakVersion} \\`,
-                `   start-dev`,
-                ""
-            ].join("\n"),
-            "utf8"
-        ),
-        { mode: 0o755 }
-    );
-}
--- a/src/bin/keycloakify/keycloakify.ts
+++ b/src/bin/keycloakify/keycloakify.ts
@ -9,6 +9,7 @@ import type { CliCommandOptions } from "../main";
 import chalk from "chalk";
 import { readThisNpmPackageVersion } from "../tools/readThisNpmPackageVersion";
 import * as os from "os";
+import { rmSync } from "../tools/fs.rmSync";

 export async function command(params: { cliCommandOptions: CliCommandOptions }) {
    exit_if_maven_not_installed: {
@ -76,7 +77,12 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
        );
    }

-    await generateSrcMainResources({ buildContext });
+    const resourcesDirPath = pathJoin(buildContext.keycloakifyBuildDirPath, "resources");
+
+    await generateSrcMainResources({
+        resourcesDirPath,
+        buildContext
+    });

    run_post_build_script: {
        if (buildContext.bundler !== "vite") {
@ -84,7 +90,7 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
        }

        child_process.execSync("npx vite", {
-            cwd: buildContext.projectDirPath,
+            cwd: resourcesDirPath,
            env: {
                ...process.env,
                [vitePluginSubScriptEnvNames.runPostBuildScript]:
@ -98,7 +104,11 @@ export async function command(params: { cliCommandOptions: CliCommandOptions })
            break build_jars;
        }

-        await buildJars({ buildContext });
+        await buildJars({ resourcesDirPath, buildContext });
+    }
+
+    if (Date.now() === 0) {
+        rmSync(resourcesDirPath, { recursive: true });
    }

    console.log(